node-zendesk • Docs

---

node-zendesk / clients/core/search / Search

Class: Search

Client for the Zendesk Search API.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/

Extends

• Client

Constructors

new Search()

new Search(options): Search

Parameters

• options: any

Returns

Search

Overrides

Client.constructor

Defined in

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

---

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

Client.delete

Defined in

clients/client.d.ts:76

---

emit()

emit(eventType, eventData): void

Parameters

• eventType: any

• eventData: any

Returns

void

Inherited from

Client.emit

Defined in

clients/client.d.ts:43

---

exportResults()

exportResults(searchTerm, objectType, pageSize?): Promise<any[]>

Export the search results for the given term.

Parameters

• searchTerm: string

The term to search for.

• objectType: string

The type of object to return (ticket, organization, user, or group).

• pageSize?: number

The number of results per page.

Returns

Promise<any[]>

An array of search results.

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/#export-search-results

Example

const { results } = await client.search.exportResults('open tickets', 'ticket');

Defined in

clients/core/search.d.ts:69

---

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

---

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

---

query()

query(searchTerm): Promise<object>

Search for the given term and retrieve results.

Parameters

• searchTerm: string

The term to search for.

Returns

Promise<object>

A JSON object with the search results.

response

response: object

result

result: object

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/#list-search-results

Example

const results = await client.search.query('open tickets');

Defined in

clients/core/search.d.ts:16

---

queryAll()

queryAll(searchTerm): Promise<any[]>

Search for the given term and retrieve all results.

Parameters

• searchTerm: string

The term to search for.

Returns

Promise<any[]>

An array of search results.

Example

const allResults = await client.search.queryAll('open tickets');

Defined in

clients/core/search.d.ts:27

---

queryAnonymous()

queryAnonymous(searchTerm): Promise<object>

Anonymous search for the given term and retrieve results.

Parameters

• searchTerm: string

The term to search for.

Returns

Promise<object>

A JSON object with the search results.

response

response: object

result

result: object

Example

const anonResults = await client.search.queryAnonymous('open tickets');

Defined in

clients/core/search.d.ts:35

---

queryAnonymousAll()

queryAnonymousAll(searchTerm): Promise<any[]>

Anonymous search for the given term and retrieve all results.

Parameters

• searchTerm: string

The term to search for.

Returns

Promise<any[]>

An array of search results.

Example

const allAnonResults = await client.search.queryAnonymousAll('open tickets');

Defined in

clients/core/search.d.ts:46

---

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

---

showResultsCount()

showResultsCount(searchTerm): Promise<object>

Retrieve the count of search results for the given term.

Parameters

• searchTerm: string

The term to search for.

Returns

Promise<object>

An Object with the number of items matching the query.

response

response: object

result

result: object

See

https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/#show-results-count

Example

const { count } = await client.search.showResultsCount('open tickets');

Defined in

clients/core/search.d.ts:55