node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/oauthclients / OAuthClients

Class: OAuthClients ​

Represents a client for Zendesk OAuth Clients API.

See ​

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/

Extends ​

Constructors ​

new OAuthClients() ​

new OAuthClients(options): OAuthClients

Parameters ​

• options: any

Returns ​

OAuthClients

Overrides ​

Client.constructor

Defined in ​

clients/core/oauthclients.d.ts:6

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

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

Creates a new OAuth client with the provided details.

Parameters ​

• client: object

The details of the client to be created.

Returns ​

Promise<object>

The details of the created OAuth client.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#create-client

Example ​

ts
const newClient = {
  name: "Test Client",
  identifier: "unique_id"
};
const createdClient = await client.oauthclients.create(newClient);

Defined in ​

clients/core/oauthclients.d.ts:41

delete() ​

delete(id): Promise<void>

Deletes a specific OAuth client by ID.

Parameters ​

• id: number

The ID of the OAuth client.

Returns ​

Promise<void>

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#delete-client

Example ​

ts
await client.oauthclients.delete(1234);

Overrides ​

Client.delete

Defined in ​

clients/core/oauthclients.d.ts:70

emit() ​

emit(eventType, eventData): void

Parameters ​

• eventType: any

• eventData: any

Returns ​

void

Inherited from ​

Client.emit

Defined in ​

clients/client.d.ts:43

generateSecret() ​

generateSecret(id): Promise<object>

Generates a new client secret for a specific OAuth client by ID.

Parameters ​

• id: number

The ID of the OAuth client.

Returns ​

Promise<object>

The new client secret.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#generate-secret

Example ​

ts
const newSecret = await client.oauthclients.generateSecret(1234);

Defined in ​

clients/core/oauthclients.d.ts:79

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<any[]>

Lists all OAuth clients.

Returns ​

Promise<any[]>

A list of OAuth clients.

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#list-clients

Example ​

ts
const clientsList = await client.oauthclients.list();

Defined in ​

clients/core/oauthclients.d.ts:15

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

Retrieves a specific OAuth client by ID.

Parameters ​

• id: number

The ID of the OAuth client.

Returns ​

Promise<object>

The OAuth client details.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#show-client

Example ​

ts
const clientDetails = await client.oauthclients.show(1234);

Defined in ​

clients/core/oauthclients.d.ts:24

update() ​

update(id, client): Promise<object>

Updates a specific OAuth client by ID.

Parameters ​

• id: number

The ID of the OAuth client.

• client: object

The new details of the client.

Returns ​

Promise<object>

The updated OAuth client details.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#update-client

Example ​

ts
const updatedClient = {
  name: "My New OAuth2 Client"
};
const updatedDetails = await client.oauthclients.update(1234, updatedClient);

Defined in ​

clients/core/oauthclients.d.ts:58

Released under the MIT License.

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