node-zendesk • Docs
node-zendesk / clients/core/locales / Locales
Class: Locales
Represents the Locales endpoint of the Zendesk REST API wrapper.
See
https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/
Extends
Constructors
new Locales()
new Locales(
options):Locales
Parameters
• options: any
Returns
Overrides
Defined in
clients/core/locales.d.ts:6
Properties
_transporter
_transporter:
Transporter
Inherited from
Defined in
clients/client.d.ts:42
eventTarget
eventTarget:
CustomEventTarget
Event target to handle custom events.
Inherited from
Defined in
clients/client.d.ts:40
jsonAPINames
jsonAPINames:
string[]
Array to hold names used in the JSON API.
Overrides
Defined in
clients/core/locales.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
Defined in
clients/client.d.ts:34
sideLoad
sideLoad:
any[]
Array to handle side-loaded resources.
Inherited from
Defined in
clients/client.d.ts:37
useDotJson
useDotJson:
boolean
Flag to indicate if the API endpoint should use '.json' ending.
Inherited from
Defined in
clients/client.d.ts:39
Accessors
transporter
Get Signature
get transporter():
Transporter
Returns
Transporter for making requests.
Inherited from
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
Defined in
clients/client.d.ts:78
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.
response
response:
object
result
result:
object
Throws
Throws an error if the API request fails.
See
Example
const client = createClient({...});
const currentLocale = await client.locales.current();Defined in
clients/core/locales.d.ts:54
delete()
delete(...
arguments_):Promise<void|object>
Deletes a resource.
Parameters
• ...arguments_: any[]
The resources or parts of the resource path.
Returns
Promise<void | object>
- Either void or response object
Inherited from
Defined in
clients/client.d.ts:76
detectBestLocale()
detectBestLocale(
availableLocales):Promise<object>
Detects the best language/locale for the user based on provided available locales.
Parameters
• availableLocales: string[]
Array of available locales e.g., ['es', 'ja', 'en-uk'].
Returns
Promise<object>
Best detected locale for the user.
response
response:
object
result
result:
object
Throws
Throws an error if the API request fails.
See
Example
const client = createClient({...});
const bestLocale = await client.locales.detectBestLocale(['es', 'ja', 'en-uk']);Defined in
clients/core/locales.d.ts:88
emit()
emit(
eventType,eventData):void
Parameters
• eventType: any
• eventData: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:43
get()
get(
resource):Promise<NodeModule>
Parameters
• resource: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:62
getAll()
getAll(
resource):Promise<any[]>
Parameters
• resource: any
Returns
Promise<any[]>
Inherited from
Defined in
clients/client.d.ts:77
list()
list():
Promise<object[]>
Lists all the translation locales available for the account.
Returns
Promise<object[]>
List of locales.
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:17
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.
Throws
Throws an error if the API request fails.
See
Example
const client = createClient({...});
const agentLocales = await client.locales.listForAgent();Defined in
clients/core/locales.d.ts:67
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.
Throws
Throws an error if the API request fails.
See
Example
const client = createClient({...});
const publicLocales = await client.locales.listPublicLocales();Defined in
clients/core/locales.d.ts:77
on()
on(
eventType,callback):void
Parameters
• eventType: any
• callback: any
Returns
void
Inherited from
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
Defined in
clients/client.d.ts:68
post()
post(
resource,body):Promise<NodeModule>
Parameters
• resource: any
• body: any
Returns
Promise<NodeModule>
Inherited from
Defined in
clients/client.d.ts:70
put()
put(
resource,body):Promise<NodeModule>
Parameters
• resource: any
• body: any
Returns
Promise<NodeModule>
Inherited from
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
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
Defined in
clients/client.d.ts:97
requestUpload()
requestUpload(
uri,file):Promise<any>
Parameters
• uri: any
• file: any
Returns
Promise<any>
Inherited from
Defined in
clients/client.d.ts:98
setSideLoad()
setSideLoad(
array):void
Parameters
• array: any
Returns
void
Inherited from
Defined in
clients/client.d.ts:61
show()
show(
localeID):Promise<object>
Retrieves information about a specific locale based on the localeID.
Parameters
• 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.
response
response:
object
result
result:
object
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:28
showCurrent()
showCurrent():
Promise<object>
Retrieves the locale information of the currently logged-in user.
Returns
Promise<object>
Details of the current user's locale.
response
response:
object
result
result:
object
Throws
Throws an error if the API request fails.
See
Example
const client = createClient({...});
const currentLocale = await client.locales.showCurrent();Defined in
clients/core/locales.d.ts:41