node-zendesk • Docs
node-zendesk / clients/core/sharingagreement / SharingAgreement
Class: SharingAgreement
Class representing the SharingAgreement API methods.
See
https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/
Extends
Constructors
new SharingAgreement()
new SharingAgreement(
options):SharingAgreement
Parameters
• options: any
Returns
Overrides
Defined in
clients/core/sharingagreement.d.ts:6
Properties
_transporter
_transporter:
Transporter
Inherited from
Defined in
clients/client.d.ts:42
eventTarget
eventTarget:
CustomEventTarget
Event target to handle custom events.
Inherited from
Defined in
clients/client.d.ts:40
jsonAPINames
jsonAPINames:
string[]
Array to hold names used in the JSON API.
Overrides
Defined in
clients/core/sharingagreement.d.ts:7
options
options:
ZendeskClientOptions&object
Configuration options for the client.
Type declaration
get()
get: (
key) =>any
Parameters
• key: string
Returns
any
Inherited from
Defined in
clients/client.d.ts:34
sideLoad
sideLoad:
any[]
Array to handle side-loaded resources.
Inherited from
Defined in
clients/client.d.ts:37
useDotJson
useDotJson:
boolean
Flag to indicate if the API endpoint should use '.json' ending.
Inherited from
Defined in
clients/client.d.ts:39
Accessors
transporter
Get Signature
get transporter():
Transporter
Returns
Transporter for making requests.
Inherited from
Defined in
clients/client.d.ts:41
Methods
_rawRequest()
_rawRequest(
method,uri, ...arguments_):Promise<object>
Parameters
• method: any
• uri: any
• ...arguments_: any[]
Returns
Promise<object>
response
response:
any
result
result:
object
Inherited from
Defined in
clients/client.d.ts:78
create()
create(
data):Promise<object>
Create a new Sharing Agreement.
Parameters
• data: object
The data for the new Sharing Agreement.
Returns
Promise<object>
The created Sharing Agreement object.
response
response:
object
result
result:
object
Throws
Throws an error if the request fails.
See
Example
const newSharingAgreement = {
remote_subdomain: "Foo"
};
const createdAgreement = await client.sharingagreement.create(newSharingAgreement);Defined in
clients/core/sharingagreement.d.ts:45
delete()
delete(
id):Promise<void>
Delete a specific Sharing Agreement by its ID.
Parameters
• id: number
The ID of the Sharing Agreement.
Returns
Promise<void>
Throws
Throws an error if the request fails.
See
Example
await client.sharingagreement.delete(12345);Overrides
Defined in
clients/core/sharingagreement.d.ts:75
emit()
emit(
eventType,eventData):void
Parameters
• eventType: any
• eventData: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:43
get()
get(
resource):Promise<NodeModule>
Parameters
• resource: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:62
getAll()
getAll(
resource):Promise<any[]>
Parameters
• resource: any
Returns
Promise<any[]>
Inherited from
Defined in
clients/client.d.ts:77
on()
on(
eventType,callback):void
Parameters
• eventType: any
• callback: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:44
patch()
patch(...
arguments_):Promise<void|object>
Patches a resource.
Parameters
• ...arguments_: any[]
The resources or parts of the resource path followed by the body.
Returns
Promise<void | object>
- Either void or response object
Inherited from
Defined in
clients/client.d.ts:68
post()
post(
resource,body):Promise<NodeModule>
Parameters
• resource: any
• body: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:70
put()
put(
resource,body):Promise<NodeModule>
Parameters
• resource: any
• body: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:69
request()
request<
T>(method,uri, ...arguments_):Promise<NodeModule>
Request method that handles various HTTP methods.
Type Parameters
• T
Parameters
• method: string
HTTP method (e.g., 'GET', 'POST').
• uri: string
The URI for the request.
• ...arguments_: any[]
Additional arguments for the request.
Returns
Promise<NodeModule>
- The API response.
Inherited from
Defined in
clients/client.d.ts:96
requestAll()
requestAll(
method,uri, ...arguments_):Promise<any[]>
Parameters
• method: any
• uri: any
• ...arguments_: any[]
Returns
Promise<any[]>
Inherited from
Defined in
clients/client.d.ts:97
requestUpload()
requestUpload(
uri,file):Promise<any>
Parameters
• uri: any
• file: any
Returns
Promise<any>
Inherited from
Defined in
clients/client.d.ts:98
setSideLoad()
setSideLoad(
array):void
Parameters
• array: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:61
show()
show():
Promise<object>
List all Sharing Agreements.
Returns
Promise<object>
An array of Sharing Agreement objects.
response
response:
object
result
result:
object[]
Throws
Throws an error if the request fails.
See
Example
const sharingAgreements = await client.sharingagreement.show();Defined in
clients/core/sharingagreement.d.ts:16
showById()
showById(
id):Promise<object>
Show a specific Sharing Agreement by its ID.
Parameters
• id: number
The ID of the Sharing Agreement.
Returns
Promise<object>
The Sharing Agreement object.
response
response:
object
result
result:
object
Throws
Throws an error if the request fails.
See
Example
const sharingAgreement = await client.sharingagreement.showById(12345);Defined in
clients/core/sharingagreement.d.ts:29
update()
update(
id,data):Promise<object>
Update an existing Sharing Agreement.
Parameters
• 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.
response
response:
object
result
result:
object
Throws
Throws an error if the request fails.
See
Example
const updatedData = {
status: "accepted"
};
const updatedAgreement = await client.sharingagreement.update(12345, updatedData);Defined in
clients/core/sharingagreement.d.ts:62