node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/satisfactionratings / SatisfactionRatings

Class: SatisfactionRatings ​

Client for the Satisfaction Ratings section of the Zendesk API.

See ​

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

Extends ​

Constructors ​

new SatisfactionRatings() ​

new SatisfactionRatings(options): SatisfactionRatings

Creates a new SatisfactionRatings instance.

Parameters ​

• 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:42

eventTarget ​

eventTarget: CustomEventTarget

Event target to handle custom events.

Inherited from ​

Client.eventTarget

Defined in ​

clients/client.d.ts:40

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: ZendeskClientOptions & object

Configuration options for the client.

Type declaration ​

get() ​

get: (key) => any

Parameters ​

• key: string

Returns ​

any

Inherited from ​

Client.options

Defined in ​

clients/client.d.ts:34

sideLoad ​

sideLoad: any[]

Array to handle side-loaded resources.

Inherited from ​

Client.sideLoad

Defined in ​

clients/client.d.ts:37

useDotJson ​

useDotJson: boolean

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

Inherited from ​

Client.useDotJson

Defined in ​

clients/client.d.ts:39

Accessors ​

transporter ​

Get Signature ​

get transporter(): Transporter

Returns ​

Transporter

Transporter for making requests.

Inherited from ​

Client.transporter

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 ​

Client._rawRequest

Defined in ​

clients/client.d.ts:78

create() ​

create(ticketID, satisfactionRating): Promise<object>

Creates a satisfaction rating for a ticket.

Parameters ​

• ticketID: number

The ID of the ticket.

• satisfactionRating: object

The details of the satisfaction rating to create.

Returns ​

Promise<object>

The created satisfaction rating.

response ​

response: object

result ​

result: object

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 ​

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

Defined in ​

clients/core/satisfactionratings.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 ​

Client.delete

Defined in ​

clients/client.d.ts:76

emit() ​

emit(eventType, eventData): void

Parameters ​

• eventType: any

• eventData: any

Returns ​

void

Inherited from ​

Client.emit

Defined in ​

clients/client.d.ts:43

get() ​

get(resource): Promise<NodeModule>

Parameters ​

• resource: any

Returns ​

Promise<NodeModule>

Inherited from ​

Client.get

Defined in ​

clients/client.d.ts:62

getAll() ​

getAll(resource): Promise<any[]>

Parameters ​

• resource: any

Returns ​

Promise<any[]>

Inherited from ​

Client.getAll

Defined in ​

clients/client.d.ts:77

incremental() ​

incremental(startTime): Promise<object>

Incrementally exports satisfaction ratings based on a start time.

Parameters ​

• startTime: number

The start time for the incremental export (Unix epoch time).

Returns ​

Promise<object>

A list of satisfaction ratings from the specified start time.

response ​

response: object

result ​

result: object[]

See ​

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

Example ​

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

Defined in ​

clients/core/satisfactionratings.d.ts:60

list() ​

list(): any[]

Lists all satisfaction ratings.

Returns ​

any[]

A list of satisfaction ratings.

See ​

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

Example ​

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

Defined in ​

clients/core/satisfactionratings.d.ts:18

on() ​

on(eventType, callback): void

Parameters ​

• eventType: any

• callback: any

Returns ​

void

Inherited from ​

Client.on

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 ​

Client.patch

Defined in ​

clients/client.d.ts:68

post() ​

post(resource, body): Promise<NodeModule>

Parameters ​

• resource: any

• body: any

Returns ​

Promise<NodeModule>

Inherited from ​

Client.post

Defined in ​

clients/client.d.ts:70

put() ​

put(resource, body): Promise<NodeModule>

Parameters ​

• resource: any

• body: any

Returns ​

Promise<NodeModule>

Inherited from ​

Client.put

Defined in ​

clients/client.d.ts:69

received() ​

received(): any[]

Lists all received satisfaction ratings.

Returns ​

any[]

A list of received satisfaction ratings.

Example ​

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

Defined in ​

clients/core/satisfactionratings.d.ts:24

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 ​

Client.request

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 ​

Client.requestAll

Defined in ​

clients/client.d.ts:97

requestUpload() ​

requestUpload(uri, file): Promise<any>

Parameters ​

• uri: any

• file: any

Returns ​

Promise<any>

Inherited from ​

Client.requestUpload

Defined in ​

clients/client.d.ts:98

setSideLoad() ​

setSideLoad(array): void

Parameters ​

• array: any

Returns ​

void

Inherited from ​

Client.setSideLoad

Defined in ​

clients/client.d.ts:61

show() ​

show(satisfactionRatingID): Promise<object>

Retrieves details of a specific satisfaction rating.

Parameters ​

• satisfactionRatingID: number

The ID of the satisfaction rating to retrieve.

Returns ​

Promise<object>

Details of the satisfaction rating.

response ​

response: object

result ​

result: object

See ​

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

Example ​

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

Defined in ​

clients/core/satisfactionratings.d.ts:32

Released under the MIT License.

Copyright © 2012-present | Made by Farrin A. Reid with ❤️