node-zendesk / Exports / clients/core/installations / Installations

Class: Installations

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

Hierarchy

• Client

  ↳ Installations

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

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

Constructors

constructor

• new Installations(options): Installations

Parameters

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

---

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

Create a new app installation.

Parameters

Name	Type	Description
installation	object	The app installation data to be created.

Returns

Promise<object>

The response data from creating the app installation.

Async

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

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

Name	Type	Description
installationID	number	The ID of the app installation.

Returns

Promise<void>

Returns the response from Zendesk API.

Async

Throws

Throws an error if the API call is unsuccessful.

See

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

Example

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

Overrides

Client.delete

Defined in

clients/core/installations.d.ts:74

---

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

---

list

▸ list(): Promise<object[]>

List all app installations in the account.

Returns

Promise<object[]>

An array of app installation objects.

Async

Throws

Throws an error if the API call is unsuccessful.

See

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

Example

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

Defined in

clients/core/installations.d.ts:14

---

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

---

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

Retrieve details of a specific app installation by its ID.

Parameters

Name	Type	Description
installationID	string | number	The unique identifier for the app installation.

Returns

Promise<object>

The app installation details as an object.

Async

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

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

Defined in

clients/core/installations.d.ts:26

---

update

▸ update(installationID, installation): Promise<object>

Updates a specific app installation.

Parameters

Name	Type	Description
installationID	number	The ID of the app installation.
installation	object	The updated installation data.

Returns

Promise<object>

Returns the response from Zendesk API.

Async

Throws

Throws an error if the API call is unsuccessful.

See

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

Example

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:62