node-zendesk / Exports / clients/core/search / Search

Class: Search

clients/core/search.Search

Client for the Zendesk Search API.

See

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

Hierarchy

• Client

  ↳ Search

Table of contents

Constructors

• constructor

Properties

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

Accessors

• transporter

Methods

• _rawRequest
• delete
• emit
• exportResults
• get
• getAll
• on
• patch
• post
• put
• query
• queryAll
• queryAnonymous
• queryAnonymousAll
• request
• requestAll
• requestUpload
• setSideLoad
• showResultsCount

Constructors

constructor

• new Search(options): Search

Parameters

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

---

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

---

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

---

exportResults

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

Export the search results for the given term.

Parameters

Name	Type	Description
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.

Async

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:66

---

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

---

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

---

query

▸ query(searchTerm): Promise<object>

Search for the given term and retrieve results.

Parameters

Name	Type	Description
searchTerm	string	The term to search for.

Returns

Promise<object>

A JSON object with the search results.

Async

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:17

---

queryAll

▸ queryAll(searchTerm): Promise<any[]>

Search for the given term and retrieve all results.

Parameters

Name	Type	Description
searchTerm	string	The term to search for.

Returns

Promise<any[]>

An array of search results.

Async

Example

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

Defined in

clients/core/search.d.ts:26

---

queryAnonymous

▸ queryAnonymous(searchTerm): Promise<object>

Anonymous search for the given term and retrieve results.

Parameters

Name	Type	Description
searchTerm	string	The term to search for.

Returns

Promise<object>

A JSON object with the search results.

Async

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

Name	Type	Description
searchTerm	string	The term to search for.

Returns

Promise<any[]>

An array of search results.

Async

Example

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

Defined in

clients/core/search.d.ts:44

---

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

---

showResultsCount

▸ showResultsCount(searchTerm): Promise<object>

Retrieve the count of search results for the given term.

Parameters

Name	Type	Description
searchTerm	string	The term to search for.

Returns

Promise<object>

An Object with the number of items matching the query.

Async

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:54