Skip to main content

Class: SearchService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/search.ts:53

Extends​

  • BaseService

Constructors​

Constructor​

new SearchService(client): SearchService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters​

client​

TanqoryClient

Returns​

SearchService

Inherited from​

BaseService.constructor

Properties​

client​

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from​

BaseService.client

Methods​

buildQuery()​

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters​

options?​

ListOptions

Returns​

Record<string, any>

Inherited from​

BaseService.buildQuery

generateIdempotencyKey()​

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters​

prefix​

string

Returns​

string

Inherited from​

BaseService.generateIdempotencyKey

getExportMimeType()​

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters​

format​

string

Returns​

string

Inherited from​

BaseService.getExportMimeType

globalSearch()​

globalSearch(storeId, query, options?): Promise<GlobalSearchResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/search.ts:74

Perform global search across multiple resource types

Parameters​

storeId​

string

Store identifier

query​

string

Search query string

options?​

GlobalSearchOptions

Optional search parameters

Returns​

Promise<GlobalSearchResponse>

Search results grouped by type

Example​

// Search all types
const results = await tanqory.search.globalSearch('store_123', 'coconut')

// Search specific types with limit
const results = await tanqory.search.globalSearch('store_123', 'john', {
  types: ['customers', 'orders'],
  limit: 10
})