Class: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:89

Main Tanqory API Client

Example

const tanqory = new TanqoryClient({
  apiKey: 'pk_live_...',
  apiVersion: 'v1'
})

// Access services
const products = await tanqory.products.list()
const order = await tanqory.orders.retrieve('ord_123')

Extends

• EventEmitter

Constructors

Constructor

new TanqoryClient(config): TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:144

Parameters

config

TanqoryConfig

Returns

TanqoryClient

Overrides

EventEmitter.constructor

Properties

aiAssistant

readonly aiAssistant: AIAssistantService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:140

---

analytics

readonly analytics: AnalyticsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:104

---

auth

readonly auth: AuthService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:97

---

billing

readonly billing: BillingService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:105

---

blogs

readonly blogs: BlogsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:130

---

checkout

readonly checkout: CheckoutService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:134

---

content

readonly content: ContentService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:126

---

customerPrivacy

readonly customerPrivacy: CustomerPrivacyService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:114

---

customers

readonly customers: CustomersService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:100

---

discounts

readonly discounts: DiscountsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:103

---

domains

readonly domains: DomainsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:111

---

email

readonly email: EmailService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:128

---

giftCardViews

readonly giftCardViews: GiftCardViewsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:132

---

inventory

readonly inventory: InventoryService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:102

---

inventoryLocations

readonly inventoryLocations: InventoryLocationsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:119

---

languages

readonly languages: LanguagesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:117

---

locations

readonly locations: LocationsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:118

---

marketing

readonly marketing: MarketingService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:115

---

markets

readonly markets: MarketsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:125

---

media

readonly media: MediaService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:107

---

metafields

readonly metafields: MetafieldsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:122

---

metaobjects

readonly metaobjects: MetaobjectsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:121

---

notifications

readonly notifications: NotificationsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:108

---

orders

readonly orders: OrdersService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:101

---

pages

readonly pages: PagesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:129

---

payments

readonly payments: PaymentsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:133

---

paymentSettings

readonly paymentSettings: PaymentSettingsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:137

---

pixels

readonly pixels: PixelsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:124

---

policies

readonly policies: PoliciesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:116

---

productCategories

readonly productCategories: ProductCategoriesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:123

---

products

readonly products: ProductsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:99

---

productSubscriptions

readonly productSubscriptions: ProductSubscriptionsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:139

---

productViews

readonly productViews: ProductViewsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:131

---

purchaseOrders

readonly purchaseOrders: PurchaseOrdersService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:136

---

search

readonly search: SearchService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:141

---

sellingPlans

readonly sellingPlans: SellingPlansService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:138

---

settings

readonly settings: SettingsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:106

---

stores

readonly stores: StoresService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:98

---

subscription

readonly subscription: SubscriptionService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:127

---

suppliers

readonly suppliers: SuppliersService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:135

---

taxes

readonly taxes: TaxesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:120

---

themes

readonly themes: ThemesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:110

---

timeline

readonly timeline: TimelineService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:142

---

webhooks

readonly webhooks: WebhooksService

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:109

---

prefixed

static prefixed: string | boolean

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:9

Inherited from

EventEmitter.prefixed

Methods

addListener()

addListener<T>(event, fn, context?): this

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:45

Type Parameters

T

T extends string | symbol

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.addListener

---

clearAuth()

clearAuth(): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:459

Clear authentication

Returns

Promise<void>

---

clearTokens()

clearTokens(): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:468

Clear all tokens (alias for clearAuth)

Returns

Promise<void>

---

emit()

emit<T>(event, ...args): boolean

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends string | symbol

Parameters

event

T

args

...any[]

Returns

boolean

Inherited from

EventEmitter.emit

---

eventNames()

eventNames(): (string | symbol)[]

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Inherited from

EventEmitter.eventNames

---

getAccessToken()

getAccessToken(): Promise<string>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:437

Get current access token (may trigger refresh if expired)

Returns

Promise<string>

---

getAssetsURL()

getAssetsURL(): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:390

Get assets CDN URL Used by ThemesService for fetching static theme assets Defaults to localhost:4001 in development, assets.tanqory.com in production

Returns

string

---

getBaseURL()

getBaseURL(): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:381

Get base URL for API requests Used by services that need direct fetch access (e.g., for raw content)

Returns

string

---

getCachedAccessToken()

getCachedAccessToken(): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:445

Get cached access token without triggering refresh Useful for initialization checks where we don't want to call the API

Returns

string

---

getConfig()

getConfig(): TanqoryConfig

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:373

Get current configuration

Returns

TanqoryConfig

---

getRefreshToken()

getRefreshToken(): Promise<string>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:452

Get current refresh token

Returns

Promise<string>

---

getVersion()

getVersion(): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:483

Get SDK version

Returns

string

---

healthCheck()

healthCheck(): Promise<boolean>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:490

Health check

Returns

Promise<boolean>

---

listenerCount()

listenerCount(event): number

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

string | symbol

Returns

number

Inherited from

EventEmitter.listenerCount

---

listeners()

listeners<T>(event): (...args) => void[]

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends string | symbol

Parameters

event

T

Returns

(...args) => void[]

Inherited from

EventEmitter.listeners

---

off()

off<T>(event, fn?, context?, once?): this

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:69

Type Parameters

T

T extends string | symbol

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.off

---

on()

on<T>(event, fn, context?): this

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters

T

T extends string | symbol

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.on

---

once()

once<T>(event, fn, context?): this

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters

T

T extends string | symbol

Parameters

event

T

fn

(...args) => void

context?

any

Returns

this

Inherited from

EventEmitter.once

---

removeAllListeners()

removeAllListeners(event?): this

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

string | symbol

Returns

this

Inherited from

EventEmitter.removeAllListeners

---

removeListener()

removeListener<T>(event, fn?, context?, once?): this

Defined in: tanqory-platform-packages/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters

T

T extends string | symbol

Parameters

event

T

fn?

(...args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.removeListener

---

requestStream()

requestStream(method, path, options?): Promise<StreamResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:531

Make a streaming API request Useful for AI chat responses, large data transfers, and real-time updates

Parameters

method

string

path

string

options?

StreamOptions

Returns

Promise<StreamResponse>

Example

// Simple callback-based streaming
await tanqory.requestStream('POST', '/ai/chat', {
  body: { message: 'Hello' },
  onChunk: (chunk) => console.log('Received:', chunk),
  onComplete: (full) => console.log('Complete response:', full)
})

// Async iteration
const stream = await tanqory.requestStream('POST', '/ai/generate', {
  body: { prompt: 'Write a story' }
})

for await (const chunk of stream) {
  process.stdout.write(chunk.content)
}

// JSON lines (NDJSON) format
const stream = await tanqory.requestStream('GET', '/events', {
  jsonLines: true
})

for await (const chunk of stream) {
  console.log('Event:', chunk.data)
}

---

setAccessToken()

setAccessToken(token, expiresIn?): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:410

Set access token

Parameters

token

string

expiresIn?

number

Returns

Promise<void>

---

setAuthToken()

setAuthToken(token): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:402

Set authentication token

Parameters

token

string

Returns

Promise<void>

---

setDebugMode()

setDebugMode(enabled): void

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:475

Enable/disable debug mode

Parameters

enabled

boolean

Returns

void

---

setRefreshToken()

setRefreshToken(token): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:418

Set refresh token

Parameters

token

string

Returns

Promise<void>

---

setTokens()

setTokens(accessToken, refreshToken?, expiresIn?): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:425

Set both access and refresh tokens

Parameters

accessToken

string

refreshToken?

string

expiresIn?

number

Returns

Promise<void>

---

updateConfig()

updateConfig(updates): void

Defined in: tanqory-platform-packages/packages/api/sdk/src/core/client.ts:358

Update client configuration Also updates TokenManager and NetworkAdapter configs for consistent behavior

Parameters

updates

Partial<TanqoryConfig>

Returns

void