node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/useridentities / UserIdentities

Class: UserIdentities ​

Client for interacting with the Zendesk User Identities API.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/

Extends ​

Constructors ​

new UserIdentities() ​

new UserIdentities(options): UserIdentities

Parameters ​

• options: any

Returns ​

UserIdentities

Overrides ​

Client.constructor

Defined in ​

clients/core/useridentities.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/useridentities.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(userId, userIdentity): Promise<object>

Create a new identity for a given user.

Parameters ​

• userId: number

The ID of the user.

• userIdentity: object

The user identity details to create.

Returns ​

Promise<object>

The created user identity.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/#create-identity

Example ​

ts
const newIdentity = await client.useridentities.create(12345, {type: 'email', value: 'test@example.com'});

Defined in ​

clients/core/useridentities.d.ts:39

delete() ​

delete(userId, userIdentityId): Promise<void>

Delete a specific identity for a given user.

Parameters ​

• userId: number

The ID of the user.

• userIdentityId: number

The ID of the user identity to delete.

Returns ​

Promise<void>

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/#delete-identity

Example ​

ts
await client.useridentities.delete(12345, 67890);

Overrides ​

Client.delete

Defined in ​

clients/core/useridentities.d.ts:105

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(userId): Promise<object[]>

List all identities for a given user.

Parameters ​

• userId: number

The ID of the user.

Returns ​

Promise<object[]>

A list of user identities.

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/#list-identities

Example ​

ts
const identities = await client.useridentities.list(12345);

Defined in ​

clients/core/useridentities.d.ts:16

makePrimary() ​

makePrimary(userId, userIdentityId): Promise<object>

Make a specific identity the primary identity for a given user.

Parameters ​

• userId: number

The ID of the user.

• userIdentityId: number

The ID of the user identity to make primary.

Returns ​

Promise<object>

The updated user identity.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/#make-identity-primary

Example ​

ts
await client.useridentities.makePrimary(12345, 67890);

Defined in ​

clients/core/useridentities.d.ts:66

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

requestVerification() ​

requestVerification(userId, userIdentityId): Promise<object>

Request verification for a specific identity for a given user.

Parameters ​

• userId: number

The ID of the user.

• userIdentityId: number

The ID of the user identity to request verification for.

Returns ​

Promise<object>

The user identity verification request details.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/#request-user-verification

Example ​

ts
await client.useridentities.requestVerification(12345, 67890);

Defined in ​

clients/core/useridentities.d.ts:92

setSideLoad() ​

setSideLoad(array): void

Parameters ​

• array: any

Returns ​

void

Inherited from ​

Client.setSideLoad

Defined in ​

clients/client.d.ts:61

show() ​

show(userId, userIdentityId): Promise<object>

Show a specific identity for a given user.

Parameters ​

• userId: number

The ID of the user.

• userIdentityId: number

The ID of the user identity to show.

Returns ​

Promise<object>

The user identity details.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/#show-identity

Example ​

ts
const identity = await client.useridentities.show(12345, 67890);

Defined in ​

clients/core/useridentities.d.ts:26

update() ​

update(userId, userIdentityId, identity): Promise<object>

Update a specific identity for a given user.

Parameters ​

• userId: number

The ID of the user.

• userIdentityId: number

The ID of the user identity to update.

• identity: object

The updated identity details.

Returns ​

Promise<object>

The updated user identity.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/#update-identity

Example ​

ts
const updatedIdentity = await client.useridentities.update(12345, 67890, {verified: true});

Defined in ​

clients/core/useridentities.d.ts:53

verify() ​

verify(userId, userIdentityId): Promise<object>

Verify a specific identity for a given user.

Parameters ​

• userId: number

The ID of the user.

• userIdentityId: number

The ID of the user identity to verify.

Returns ​

Promise<object>

The verified user identity.

response ​

response: object

result ​

result: object

Throws ​

Throws an error if the request fails.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_identities/#verify-identity

Example ​

ts
await client.useridentities.verify(12345, 67890);

Defined in ​

clients/core/useridentities.d.ts:79

Released under the MIT License.

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