node-zendesk / Exports / clients/core/satisfactionratings / SatisfactionRatings

Class: SatisfactionRatings

clients/core/satisfactionratings.SatisfactionRatings

Client for the Satisfaction Ratings section of the Zendesk API.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/

Hierarchy

• Client

  ↳ SatisfactionRatings

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

• _rawRequest
• create
• delete
• emit
• get
• getAll
• incremental
• list
• on
• patch
• post
• put
• received
• request
• requestAll
• requestUpload
• setSideLoad
• show

Constructors

constructor

• new SatisfactionRatings(options): SatisfactionRatings

Creates a new SatisfactionRatings instance.

Parameters

Name	Type	Description
options	object	Options for initializing the client.

Returns

SatisfactionRatings

Overrides

Client.constructor

Defined in

clients/core/satisfactionratings.d.ts:10

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/satisfactionratings.d.ts:11

---

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(ticketID, satisfactionRating): object

Creates a satisfaction rating for a ticket.

Parameters

Name	Type	Description
ticketID	number	The ID of the ticket.
satisfactionRating	object	The details of the satisfaction rating to create.

Returns

object

The created satisfaction rating.

Async

Throws

Will throw an error if the requester is not an end user of the ticket or if the ticket is not solved.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/#create-a-satisfaction-rating

Example

const rating = {
  satisfaction_rating: { score: "good", comment: "Awesome support." }
};
const newRating = await client.satisfactionratings.create(12345, rating);

Defined in

clients/core/satisfactionratings.d.ts:50

---

delete

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

Deletes a resource.

Parameters

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

Returns

Promise<void | object>

• Either void or response object

Inherited from

Client.delete

Defined in

clients/client.d.ts:128

---

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

---

incremental

▸ incremental(startTime): any[]

Incrementally exports satisfaction ratings based on a start time.

Parameters

Name	Type	Description
startTime	number	The start time for the incremental export (Unix epoch time).

Returns

any[]

A list of satisfaction ratings from the specified start time.

Async

See

https://developer.zendesk.com/api-reference/live-chat/chat-api/incremental_export/#start-time

Example

const ratingsExported = await client.satisfactionratings.incremental(1498151194);

Defined in

clients/core/satisfactionratings.d.ts:59

---

list

▸ list(): any[]

Lists all satisfaction ratings.

Returns

any[]

A list of satisfaction ratings.

Async

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/#list-satisfaction-ratings

Example

const ratings = await client.satisfactionratings.list();

Defined in

clients/core/satisfactionratings.d.ts:19

---

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

---

received

▸ received(): any[]

Lists all received satisfaction ratings.

Returns

any[]

A list of received satisfaction ratings.

Async

Example

const ratingsReceived = await client.satisfactionratings.received();

Defined in

clients/core/satisfactionratings.d.ts:26

---

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(satisfactionRatingID): object

Retrieves details of a specific satisfaction rating.

Parameters

Name	Type	Description
satisfactionRatingID	number	The ID of the satisfaction rating to retrieve.

Returns

object

Details of the satisfaction rating.

Async

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/#show-satisfaction-rating

Example

const ratingDetails = await client.satisfactionratings.show(12345);

Defined in

clients/core/satisfactionratings.d.ts:35