Class Links

Returns a list of all Digital Links. See api docs.

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.links.list({
  bearer_token: '7381273269536713689562374856'
})

Returns a single Digital Link by its ID. See api docs.

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.links.show({
  bearer_token: '7381273269536713689562374856'
  id: '1'
})

Creates a new Digital Link and returns its attributes. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.links.create({
  bearer_token: '7381273269536713689562374856',
  digital_link: {
    access_counter: 0,
    line_item_id: '1',
    digital_id: '1'
  }
})

Update selected Digital Link for the signed in User. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.links.update({
  bearer_token: '7381273269536713689562374856',
  id: '1',
  digital_link: {
    access_counter: 0,
    line_item_id: '1',
    digital_id: '1'
  }
})

This endpoint removes the specified Digital Link for the current user. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.links.remove({
  bearer_token: '7381273269536713689562374856',
  id: '1'
})

This endpoint resets the specified Digital Link for the current user. See api docs.

Required token: Bearer token

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.links.reset({
  bearer_token: '7381273269536713689562374856',
  id: '1'
})