node-zendesk / Exports / clients/core/userfields / UserFields

Class: UserFields

clients/core/userfields.UserFields

Represents the UserFields client for the Zendesk API.

See

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

Hierarchy

• Client

  ↳ UserFields

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

• _rawRequest
• create
• createOrUpdateOption
• delete
• deleteOption
• emit
• get
• getAll
• list
• listOptions
• on
• patch
• post
• put
• reorder
• request
• requestAll
• requestUpload
• setSideLoad
• show
• showOption
• update

Constructors

constructor

• new UserFields(options): UserFields

Parameters

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

---

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

Creates a new user field.

Parameters

Name	Type	Description
userField	object	The user field data.

Returns

Promise<object>

The created user field.

Async

See

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

Example

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

Name	Type	Description
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.

Async

See

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

Example

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

Defined in

clients/core/userfields.d.ts:90

---

delete

▸ delete(userFieldID): Promise<object>

Deletes a user field.

Parameters

Name	Type	Description
userFieldID	number	The ID of the user field.

Returns

Promise<object>

The response from the delete operation.

Async

See

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

Example

await client.userfields.delete(12345);

Overrides

Client.delete

Defined in

clients/core/userfields.d.ts:52

---

deleteOption

▸ deleteOption(userFieldID, userFieldOptionID): Promise<object>

Deletes a user field option.

Parameters

Name	Type	Description
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.

Async

See

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

Example

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

Defined in

clients/core/userfields.d.ts:100

---

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>

Lists all custom user fields in the account.

Returns

Promise<object>

The list of user fields.

Async

See

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

Example

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

Defined in

clients/core/userfields.d.ts:15

---

listOptions

▸ listOptions(userFieldID): Promise<object>

Lists options for a specific dropdown user field.

Parameters

Name	Type	Description
userFieldID	number	The ID of the user field.

Returns

Promise<object>

The list of user field options.

Async

See

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

Example

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

Defined in

clients/core/userfields.d.ts:70

---

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

---

reorder

▸ reorder(userFieldIDs): Promise<object>

Reorders the user fields based on the provided IDs.

Parameters

Name	Type	Description
userFieldIDs	number[]	An array of user field IDs in the desired order.

Returns

Promise<object>

The reordered user fields.

Async

See

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

Example

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

Defined in

clients/core/userfields.d.ts:61

---

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

Retrieves details of a specific user field.

Parameters

Name	Type	Description
userFieldID	number	The ID of the user field.

Returns

Promise<object>

Details of the user field.

Async

See

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

Example

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

Defined in

clients/core/userfields.d.ts:24

---

showOption

▸ showOption(userFieldID, userFieldOptionID): Promise<object>

Retrieves details of a specific user field option.

Parameters

Name	Type	Description
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.

Async

See

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

Example

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

Defined in

clients/core/userfields.d.ts:80

---

update

▸ update(userFieldID, userField): Promise<object>

Updates an existing user field.

Parameters

Name	Type	Description
userFieldID	number	The ID of the user field.
userField	object	The updated user field data.

Returns

Promise<object>

The updated user field.

Async

See

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

Example

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

Defined in

clients/core/userfields.d.ts:43