node-zendesk / Exports / clients/core/sharingagreement / SharingAgreement

Class: SharingAgreement

clients/core/sharingagreement.SharingAgreement

Class representing the SharingAgreement API methods.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/

Hierarchy

• Client

  ↳ SharingAgreement

Table of contents

Constructors

• constructor

Properties

• _transporter
• eventTarget
• jsonAPINames
• options
• sideLoad
• useDotJson

Accessors

• transporter

Methods

• _rawRequest
• create
• delete
• emit
• get
• getAll
• on
• patch
• post
• put
• request
• requestAll
• requestUpload
• setSideLoad
• show
• showById
• update

Constructors

constructor

• new SharingAgreement(options): SharingAgreement

Parameters

Name	Type
options	any

Returns

SharingAgreement

Overrides

Client.constructor

Defined in

clients/core/sharingagreement.d.ts:6

Properties

_transporter

• _transporter: Transporter

Inherited from

Client._transporter

Defined in

clients/client.d.ts:94

---

eventTarget

• eventTarget: CustomEventTarget

Event target to handle custom events.

Inherited from

Client.eventTarget

Defined in

clients/client.d.ts:92

---

jsonAPINames

• jsonAPINames: string[]

Array to hold names used in the JSON API.

Overrides

Client.jsonAPINames

Defined in

clients/core/sharingagreement.d.ts:7

---

options

• options: ClientOptions & { get: (key: string) => any }

Configuration options for the client.

Inherited from

Client.options

Defined in

clients/client.d.ts:86

---

sideLoad

• sideLoad: any[]

Array to handle side-loaded resources.

Inherited from

Client.sideLoad

Defined in

clients/client.d.ts:89

---

useDotJson

• useDotJson: boolean

Flag to indicate if the API endpoint should use '.json' ending.

Inherited from

Client.useDotJson

Defined in

clients/client.d.ts:91

Accessors

transporter

• get transporter(): Transporter

Transporter for making requests.

Returns

Transporter

Inherited from

Client.transporter

Defined in

clients/client.d.ts:93

Methods

_rawRequest

▸ _rawRequest(method, uri, ...args): Promise<{ response: any ; result: {} }>

Parameters

Name	Type
method	any
uri	any
...args	any[]

Returns

Promise<{ response: any ; result: {} }>

Inherited from

Client._rawRequest

Defined in

clients/client.d.ts:130

---

create

▸ create(data): Promise<object>

Create a new Sharing Agreement.

Parameters

Name	Type	Description
data	object	The data for the new Sharing Agreement.

Returns

Promise<object>

The created Sharing Agreement object.

Async

Throws

Throws an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/#create-sharing-agreement

Example

const newSharingAgreement = {
  remote_subdomain: "Foo"
};
const createdAgreement = await client.sharingagreement.create(newSharingAgreement);

Defined in

clients/core/sharingagreement.d.ts:42

---

delete

▸ delete(id): Promise<void>

Delete a specific Sharing Agreement by its ID.

Parameters

Name	Type	Description
id	number	The ID of the Sharing Agreement.

Returns

Promise<void>

Async

Throws

Throws an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/#delete-a-sharing-agreement

Example

await client.sharingagreement.delete(12345);

Overrides

Client.delete

Defined in

clients/core/sharingagreement.d.ts:68

---

emit

▸ emit(eventType, eventData): void

Parameters

Name	Type
eventType	any
eventData	any

Returns

void

Inherited from

Client.emit

Defined in

clients/client.d.ts:95

---

get

▸ get(resource): Promise<NodeModule>

Parameters

Name	Type
resource	any

Returns

Promise<NodeModule>

Inherited from

Client.get

Defined in

clients/client.d.ts:114

---

getAll

▸ getAll(resource): Promise<any[]>

Parameters

Name	Type
resource	any

Returns

Promise<any[]>

Inherited from

Client.getAll

Defined in

clients/client.d.ts:129

---

on

▸ on(eventType, callback): void

Parameters

Name	Type
eventType	any
callback	any

Returns

void

Inherited from

Client.on

Defined in

clients/client.d.ts:96

---

patch

▸ patch(...args): Promise<void | object>

Patches a resource.

Parameters

Name	Type	Description
...args	any[]	The resources or parts of the resource path followed by the body.

Returns

Promise<void | object>

• Either void or response object

Inherited from

Client.patch

Defined in

clients/client.d.ts:120

---

post

▸ post(resource, body): Promise<NodeModule>

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Inherited from

Client.post

Defined in

clients/client.d.ts:122

---

put

▸ put(resource, body): Promise<NodeModule>

Parameters

Name	Type
resource	any
body	any

Returns

Promise<NodeModule>

Inherited from

Client.put

Defined in

clients/client.d.ts:121

---

request

▸ request<T>(method, uri, ...args): Promise<NodeModule>

Request method that handles various HTTP methods.

Type parameters

Name
T

Parameters

Name	Type	Description
method	string	HTTP method (e.g., 'GET', 'POST').
uri	string	The URI for the request.
...args	any[]	Additional arguments for the request.

Returns

Promise<NodeModule>

• The API response.

Inherited from

Client.request

Defined in

clients/client.d.ts:148

---

requestAll

▸ requestAll(method, uri, ...args): Promise<any[]>

Parameters

Name	Type
method	any
uri	any
...args	any[]

Returns

Promise<any[]>

Inherited from

Client.requestAll

Defined in

clients/client.d.ts:149

---

requestUpload

▸ requestUpload(uri, file): Promise<any>

Parameters

Name	Type
uri	any
file	any

Returns

Promise<any>

Inherited from

Client.requestUpload

Defined in

clients/client.d.ts:150

---

setSideLoad

▸ setSideLoad(array): void

Parameters

Name	Type
array	any

Returns

void

Inherited from

Client.setSideLoad

Defined in

clients/client.d.ts:113

---

show

▸ show(): Promise<any[]>

List all Sharing Agreements.

Returns

Promise<any[]>

An array of Sharing Agreement objects.

Async

Throws

Throws an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/#list-sharing-agreements

Example

const sharingAgreements = await client.sharingagreement.show();

Defined in

clients/core/sharingagreement.d.ts:17

---

showById

▸ showById(id): Promise<object>

Show a specific Sharing Agreement by its ID.

Parameters

Name	Type	Description
id	number	The ID of the Sharing Agreement.

Returns

Promise<object>

The Sharing Agreement object.

Async

Throws

Throws an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/#show-a-sharing-agreement

Example

const sharingAgreement = await client.sharingagreement.showById(12345);

Defined in

clients/core/sharingagreement.d.ts:28

---

update

▸ update(id, data): Promise<object>

Update an existing Sharing Agreement.

Parameters

Name	Type	Description
id	number	The ID of the Sharing Agreement to update.
data	object	The data to update the Sharing Agreement with. Only 'status' is allowed.

Returns

Promise<object>

The updated Sharing Agreement object.

Async

Throws

Throws an error if the request fails.

See

https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/#update-a-sharing-agreement

Example

const updatedData = {
  status: "accepted"
};
const updatedAgreement = await client.sharingagreement.update(12345, updatedData);

Defined in

clients/core/sharingagreement.d.ts:57