node-zendesk / Exports / clients/core/locales / Locales

Class: Locales

clients/core/locales.Locales

Description

Represents the Locales endpoint of the Zendesk REST API wrapper.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/

Hierarchy

Client
↳ Locales

Constructors

constructor

Properties

Accessors

transporter

Methods

Constructors

constructor

• new Locales(options): Locales

Parameters

Name	Type
`options`	`any`

Returns

Locales

Overrides

Client.constructor

Defined in

clients/core/locales.d.ts:7

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

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

current

▸ current(): Promise<object>

Alias for showCurrent. Retrieves the locale information of the currently logged-in user.

Returns

Promise<object>

Details of the current user's locale.

Async

Throws

Throws an error if the API request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#show-current-locale

Example

const client = createClient({...});
const currentLocale = await client.locales.current();

Defined in

clients/core/locales.d.ts:53

delete

▸ delete(...args): Promise<void | object>

Deletes a resource.

Parameters

Name	Type	Description
`...args`	`any`[]	The resources or parts of the resource path.

Returns

Promise<void | object>

Either void or response object

Inherited from

Client.delete

Defined in

clients/client.d.ts:128

detectBestLocale

▸ detectBestLocale(availableLocales): Promise<object>

Detects the best language/locale for the user based on provided available locales.

Parameters

Name	Type	Description
`availableLocales`	`string`[]	Array of available locales e.g., ['es', 'ja', 'en-uk'].

Returns

Promise<object>

Best detected locale for the user.

Async

Throws

Throws an error if the API request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#detect-best-language-for-user

Example

const client = createClient({...});
const bestLocale = await client.locales.detectBestLocale(['es', 'ja', 'en-uk']);

Defined in

clients/core/locales.d.ts:87

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 the translation locales available for the account.

Returns

Promise<object[]>

List of locales.

Async

Throws

Throws an error if the API request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#list-locales

Example

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

Defined in

clients/core/locales.d.ts:19

listForAgent

▸ listForAgent(): Promise<object[]>

Lists the translation locales that have been localized for agents on a specific account.

Returns

Promise<object[]>

List of locales available for agents.

Async

Throws

Throws an error if the API request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#list-locales-for-agent

Example

const client = createClient({...});
const agentLocales = await client.locales.listForAgent();

Defined in

clients/core/locales.d.ts:64

listPublicLocales

▸ listPublicLocales(): Promise<object[]>

Lists the translation locales that are available to all accounts.

Returns

Promise<object[]>

List of public locales available to all accounts.

Async

Throws

Throws an error if the API request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#list-available-public-locales

Example

const client = createClient({...});
const publicLocales = await client.locales.listPublicLocales();

Defined in

clients/core/locales.d.ts:75

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

Retrieves information about a specific locale based on the localeID.

Parameters

Name	Type	Description
`localeID`	`string` \| `number`	The ID or the BCP-47 code of the locale (e.g., 'en-US', 'es-419').

Returns

Promise<object>

Details of the specified locale.

Async

Throws

Throws an error if the API request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#show-locale

Example

const client = createClient({...});
const locale = await client.locales.show('en-US');

Defined in

clients/core/locales.d.ts:31

showCurrent

▸ showCurrent(): Promise<object>

Retrieves the locale information of the currently logged-in user.

Returns

Promise<object>

Details of the current user's locale.

Async

Throws

Throws an error if the API request fails.

See

https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#show-current-locale

Example

const client = createClient({...});
const currentLocale = await client.locales.showCurrent();

Defined in

clients/core/locales.d.ts:42

Class: Locales ​

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

Parameters ​

Returns ​

Overrides ​

Defined in ​

Properties ​

_transporter ​

Inherited from ​

Defined in ​

eventTarget ​

Inherited from ​

Defined in ​

jsonAPINames ​

Overrides ​

Defined in ​

options ​

Inherited from ​

Defined in ​

sideLoad ​

Inherited from ​

Defined in ​

useDotJson ​

Inherited from ​

Defined in ​

Accessors ​

transporter ​

Returns ​

Inherited from ​

Defined in ​

Methods ​

_rawRequest ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

current ​

Returns ​

Defined in ​

delete ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

detectBestLocale ​

Parameters ​

Returns ​

Defined in ​

emit ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

get ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

getAll ​

Parameters ​

Returns ​

Inherited from ​

Defined in ​

list ​

Returns ​

Defined in ​

listForAgent ​

Returns ​

Defined in ​

listPublicLocales ​

Returns ​

Defined in ​

on ​

Class: Locales

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns

Overrides

Defined in

Properties

_transporter

Inherited from

Defined in

eventTarget

Inherited from

Defined in

jsonAPINames

Overrides

Defined in

options

Inherited from

Defined in

sideLoad

Inherited from

Defined in

useDotJson

Inherited from

Defined in

Accessors

transporter

Returns

Inherited from

Defined in

Methods

_rawRequest

Parameters

Returns

Inherited from

Defined in

current

Returns

Defined in

delete

Parameters

Returns

Inherited from

Defined in

detectBestLocale

Parameters

Returns

Defined in

emit

Parameters

Returns

Inherited from

Defined in

get

Parameters

Returns

Inherited from

Defined in

getAll

Parameters

Returns

Inherited from

Defined in

list

Returns

Defined in

listForAgent

Returns

Defined in

listPublicLocales

Returns

Defined in

on