node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/userfields / UserFields

Class: UserFields ​

Represents the UserFields client for the Zendesk API.

See ​

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

Extends ​

Constructors ​

new UserFields() ​

new UserFields(options): UserFields

Parameters ​

• options: any

Returns ​

UserFields

Overrides ​

Client.constructor

Defined in ​

clients/core/userfields.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/userfields.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(userField): Promise<object>

Creates a new user field.

Parameters ​

• userField: object

The user field data.

Returns ​

Promise<object>

The created user field.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#create-user-field

Example ​

ts
const newUserField = await client.userfields.create({ type: 'text', title: 'Support description' });

Defined in ​

clients/core/userfields.d.ts:33

createOrUpdateOption() ​

createOrUpdateOption(userFieldID, customFieldOption): Promise<object>

Creates or updates a user field option.

Parameters ​

• userFieldID: number

The ID of the user field.

• customFieldOption: object

The user field option data.

Returns ​

Promise<object>

The created or updated user field option.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#create-or-update-a-user-field-option

Example ​

ts
await client.userfields.createOrUpdateOption(12345, { name: 'Grapes', position: 2, value: 'grape' });

Defined in ​

clients/core/userfields.d.ts:99

delete() ​

delete(userFieldID): Promise<object>

Deletes a user field.

Parameters ​

• userFieldID: number

The ID of the user field.

Returns ​

Promise<object>

The response from the delete operation.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#delete-user-field

Example ​

ts
await client.userfields.delete(12345);

Overrides ​

Client.delete

Defined in ​

clients/core/userfields.d.ts:56

deleteOption() ​

deleteOption(userFieldID, userFieldOptionID): Promise<object>

Deletes a user field option.

Parameters ​

• userFieldID: number

The ID of the user field.

• userFieldOptionID: number

The ID of the user field option.

Returns ​

Promise<object>

The response from the delete operation.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#delete-user-field-option

Example ​

ts
await client.userfields.deleteOption(12345, 67890);

Defined in ​

clients/core/userfields.d.ts:111

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>

Lists all custom user fields in the account.

Returns ​

Promise<object>

The list of user fields.

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#list-user-fields

Example ​

ts
const userFields = await client.userfields.list();

Defined in ​

clients/core/userfields.d.ts:14

listOptions() ​

listOptions(userFieldID): Promise<object>

Lists options for a specific dropdown user field.

Parameters ​

• userFieldID: number

The ID of the user field.

Returns ​

Promise<object>

The list of user field options.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#list-user-field-options

Example ​

ts
const options = await client.userfields.listOptions(12345);

Defined in ​

clients/core/userfields.d.ts:75

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

reorder() ​

reorder(userFieldIDs): Promise<object>

Reorders the user fields based on the provided IDs.

Parameters ​

• userFieldIDs: number[]

An array of user field IDs in the desired order.

Returns ​

Promise<object>

The reordered user fields.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#reorder-user-field

Example ​

ts
await client.userfields.reorder([3, 4]);

Defined in ​

clients/core/userfields.d.ts:64

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

Retrieves details of a specific user field.

Parameters ​

• userFieldID: number

The ID of the user field.

Returns ​

Promise<object>

Details of the user field.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#show-user-field

Example ​

ts
const userField = await client.userfields.show(12345);

Defined in ​

clients/core/userfields.d.ts:22

showOption() ​

showOption(userFieldID, userFieldOptionID): Promise<object>

Retrieves details of a specific user field option.

Parameters ​

• userFieldID: number

The ID of the user field.

• userFieldOptionID: number

The ID of the user field option.

Returns ​

Promise<object>

Details of the user field option.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#show-a-user-field-option

Example ​

ts
const option = await client.userfields.showOption(12345, 67890);

Defined in ​

clients/core/userfields.d.ts:87

update() ​

update(userFieldID, userField): Promise<object>

Updates an existing user field.

Parameters ​

• userFieldID: number

The ID of the user field.

• userField: object

The updated user field data.

Returns ​

Promise<object>

The updated user field.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#update-user-field

Example ​

ts
await client.userfields.update(12345, { title: 'Updated Support description' });

Defined in ​

clients/core/userfields.d.ts:45

Released under the MIT License.

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