node-zendesk • Docs
node-zendesk / clients/core/activitystream / ActivityStream
Class: ActivityStream
ActivityStream provides methods to interact with Zendesk ticket activities. This class extends the base Client class and is tailored to fetch activity data.
See
Example
const client = new Client({ /* ...options... * / });
const activities = await client.activitystream.list();Extends
Constructors
new ActivityStream()
new ActivityStream(
options):ActivityStream
Creates an instance of the ActivityStream client.
Parameters
• options: object
Configuration options for the client.
Returns
Overrides
Defined in
clients/core/activitystream.d.ts:14
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/activitystream.d.ts:15
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
count()
count():
Promise<object>
Returns an approximate count of ticket activities in the last 30 days affecting the agent making the request. If the count exceeds 100,000, the count will return a cached result which updates every 24 hours.
The count[refreshed_at] property is a timestamp that indicates when the count was last updated. Note: When the count exceeds 100,000, count[refreshed_at] may occasionally be null. This indicates that the count is being updated in the background, and count[value] is limited to 100,000 until the update is complete.
Returns
Promise<object>
A promise that resolves to an object containing the activity count and the refreshed_at timestamp.
response
response:
object
result
result:
object
See
Zendesk API - Count Activities
Example
const activityCount = await client.activitystream.count();
console.log(activityCount); // { count: { refreshed_at: "2020-04-06T02:18:17Z", value: 102 } }Defined in
clients/core/activitystream.d.ts:49
delete()
delete(...
arguments_):Promise<void|object>
Deletes a resource.
Parameters
• ...arguments_: any[]
The resources or parts of the resource path.
Returns
Promise<void | object>
- Either void or response object
Inherited from
Defined in
clients/client.d.ts:76
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
list()
list():
object[]
Lists all ticket activities from the Zendesk API.
Returns
object[]
An array of activity objects.
See
Example
const activities = await client.activitystream.list();Defined in
clients/core/activitystream.d.ts:23
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(
activityID):Promise<object>
Retrieves a specific ticket activity by its ID.
Parameters
• activityID: number
The unique ID of the activity to fetch.
Returns
Promise<object>
A promise that resolves to the activity object corresponding to the provided activityID.
response
response:
object
result
result:
object
See
Example
const activity = await client.activitystream.show(12345); // Where 12345 is an activity ID.Defined in
clients/core/activitystream.d.ts:32