node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/installations / Installations

Class: Installations ​

Represents a client to interact with the Zendesk API, providing functionalities to make various types of requests. This client handles request construction, response processing, event emission, and more.

Extends ​

Constructors ​

new Installations() ​

new Installations(options): Installations

Parameters ​

• options: any

Returns ​

Installations

Overrides ​

Client.constructor

Defined in ​

clients/core/installations.d.ts:2

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/installations.d.ts:3

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

Create a new app installation.

Parameters ​

• installation: object

The app installation data to be created.

Returns ​

Promise<object>

The response data from creating the app installation.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the API call is unsuccessful or if the installation data is invalid.

See ​

https://developer.zendesk.com/api-reference/ticketing/apps/apps/#install-app For more details about creating an installation.

Example ​

ts
const client = createClient({...});
const installationData = {
  name: 'My App Installation',
  config: {...},
  // ... other installation properties ...
};
const response = await client.installations.create(installationData);

Defined in ​

clients/core/installations.d.ts:43

delete() ​

delete(installationID): Promise<void>

Removes a specific app installation.

Parameters ​

• installationID: number

The ID of the app installation.

Returns ​

Promise<void>

Returns the response from Zendesk API.

Throws ​

Throws an error if the API call is unsuccessful.

See ​

https://developer.zendesk.com/api-reference/ticketing/apps/apps/#remove-app-installation

Example ​

ts
const client = createClient({...});
await client.installations.delete(12345);

Overrides ​

Client.delete

Defined in ​

clients/core/installations.d.ts:78

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

list() ​

list(): Promise<object[]>

List all app installations in the account.

Returns ​

Promise<object[]>

An array of app installation objects.

Throws ​

Throws an error if the API call is unsuccessful.

See ​

https://developer.zendesk.com/api-reference/ticketing/apps/apps/#list-app-installations

Example ​

ts
const client = createClient({...});
const appInstallations = await client.apps.list();

Defined in ​

clients/core/installations.d.ts:13

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

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

Retrieve details of a specific app installation by its ID.

Parameters ​

• installationID: string | number

The unique identifier for the app installation.

Returns ​

Promise<object>

The app installation details as an object.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the API call is unsuccessful or the installationID is invalid.

See ​

https://developer.zendesk.com/api-reference/ticketing/apps/apps/#show-app-installation

Example ​

ts
const client = createClient({...});
const appInstallationDetails = await client.apps.show(12345); // Replace 12345 with a valid installation ID

Defined in ​

clients/core/installations.d.ts:24

update() ​

update(installationID, installation): Promise<object>

Updates a specific app installation.

Parameters ​

• installationID: number

The ID of the app installation.

• installation: object

The updated installation data.

Returns ​

Promise<object>

Returns the response from Zendesk API.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the API call is unsuccessful.

See ​

https://developer.zendesk.com/api-reference/ticketing/apps/apps/#update-app-installation

Example ​

ts
const client = createClient({...});
const updatedInstallationData = {
  settings: {
    name: "Helpful App - Updated",
    api_token: "659323ngt4ut9an"
  }
};
const response = await client.installations.update(12345, updatedInstallationData);

Defined in ​

clients/core/installations.d.ts:64

Released under the MIT License.

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