node-zendesk

Appearance

node-zendesk • Docs

node-zendesk / clients/core/brand / Brand

Class: Brand ​

Class representing the Brand API endpoints.

See ​

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

Extends ​

Constructors ​

new Brand() ​

new Brand(options): Brand

Parameters ​

• options: any

Returns ​

Brand

Overrides ​

Client.constructor

Defined in ​

clients/core/brand.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/brand.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

checkHostMapping() ​

checkHostMapping(hostMapping, subdomain): Promise<object>

Check host mapping validity for a given subdomain and host mapping.

Parameters ​

• hostMapping: string

The host mapping to check.

• subdomain: string

The subdomain to check.

Returns ​

Promise<object>

The check result.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#check-host-mapping-validity

Example ​

ts
await client.brands.checkHostMapping("brand1.com", "brand1");

Defined in ​

clients/core/brand.d.ts:68

checkHostMappingForExistingBrand() ​

checkHostMappingForExistingBrand(brandId): Promise<object>

Check host mapping validity for an existing brand.

Parameters ​

• brandId: number

The ID of the brand to check.

Returns ​

Promise<object>

The check result.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#check-host-mapping-validity-for-an-existing-brand

Example ​

ts
await client.brands.checkHostMappingForExistingBrand(47);

Defined in ​

clients/core/brand.d.ts:79

create() ​

create(brand): Promise<object>

Create a new brand.

Parameters ​

• brand: object

The brand data.

Returns ​

Promise<object>

The created brand details.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#create-brand

Example ​

ts
const newBrand = await client.brands.create({name: "Brand 1", subdomain: "Brand1"});

Defined in ​

clients/core/brand.d.ts:36

delete() ​

delete(brandId): Promise<object>

Delete a brand.

Parameters ​

• brandId: number

The ID of the brand to delete.

Returns ​

Promise<object>

The deletion status.

See ​

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#delete-a-brand

Example ​

ts
await client.brands.delete(47);

Overrides ​

Client.delete

Defined in ​

clients/core/brand.d.ts:59

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>

List all brands.

Returns ​

Promise<object>

The list of brands.

response ​

response: object

result ​

result: object[]

See ​

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

Example ​

ts
const brands = await client.brands.list();

Defined in ​

clients/core/brand.d.ts:14

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

setSideLoad() ​

setSideLoad(array): void

Parameters ​

• array: any

Returns ​

void

Inherited from ​

Client.setSideLoad

Defined in ​

clients/client.d.ts:61

show() ​

show(brandId): Promise<object>

Show a specific brand by ID.

Parameters ​

• brandId: number

The ID of the brand.

Returns ​

Promise<object>

The brand details.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#show-a-brand

Example ​

ts
const brand = await client.brands.show(47);

Defined in ​

clients/core/brand.d.ts:25

update() ​

update(brand, brandId): Promise<object>

Update an existing brand.

Parameters ​

• brand: object

The updated brand data.

• brandId: number

The ID of the brand to update.

Returns ​

Promise<object>

The updated brand details.

response ​

response: object

result ​

result: object

See ​

https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#update-a-brand

Example ​

ts
const updatedBrand = await client.brands.update({name: "Updated Brand"}, 47);

Defined in ​

clients/core/brand.d.ts:48

Released under the MIT License.

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