node-zendesk / Exports / clients/core/brand / Brand

Class: Brand

clients/core/brand.Brand

Class representing the Brand API endpoints.

See

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

Hierarchy

• Client

  ↳ Brand

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

• _rawRequest
• checkHostMapping
• checkHostMappingForExistingBrand
• create
• delete
• emit
• get
• getAll
• list
• on
• patch
• post
• put
• request
• requestAll
• requestUpload
• setSideLoad
• show
• update

Constructors

constructor

• new Brand(options): Brand

Parameters

Name	Type
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: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/brand.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

---

checkHostMapping

▸ checkHostMapping(hostMapping, subdomain): Promise<object>

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

Parameters

Name	Type	Description
hostMapping	string	The host mapping to check.
subdomain	string	The subdomain to check.

Returns

Promise<object>

The check result.

Async

See

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

Example

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

Defined in

clients/core/brand.d.ts:62

---

checkHostMappingForExistingBrand

▸ checkHostMappingForExistingBrand(brandId): Promise<object>

Check host mapping validity for an existing brand.

Parameters

Name	Type	Description
brandId	number	The ID of the brand to check.

Returns

Promise<object>

The check result.

Async

See

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

Example

await client.brands.checkHostMappingForExistingBrand(47);

Defined in

clients/core/brand.d.ts:71

---

create

▸ create(brand): Promise<object>

Create a new brand.

Parameters

Name	Type	Description
brand	object	The brand data.

Returns

Promise<object>

The created brand details.

Async

See

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

Example

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

Defined in

clients/core/brand.d.ts:33

---

delete

▸ delete(brandId): Promise<object>

Delete a brand.

Parameters

Name	Type	Description
brandId	number	The ID of the brand to delete.

Returns

Promise<object>

The deletion status.

Async

See

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

Example

await client.brands.delete(47);

Overrides

Client.delete

Defined in

clients/core/brand.d.ts:52

---

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>

List all brands.

Returns

Promise<object>

The list of brands.

Async

See

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

Example

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

Defined in

clients/core/brand.d.ts:15

---

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

Show a specific brand by ID.

Parameters

Name	Type	Description
brandId	number	The ID of the brand.

Returns

Promise<object>

The brand details.

Async

See

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

Example

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

Defined in

clients/core/brand.d.ts:24

---

update

▸ update(brand, brandId): Promise<object>

Update an existing brand.

Parameters

Name	Type	Description
brand	object	The updated brand data.
brandId	number	The ID of the brand to update.

Returns

Promise<object>

The updated brand details.

Async

See

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

Example

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

Defined in

clients/core/brand.d.ts:43