Class: PoliciesService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:23

Extends

• BaseService

Constructors

Constructor

new PoliciesService(client): PoliciesService

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

Parameters

client

TanqoryClient

Returns

PoliciesService

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

---

checkAiHealth()

checkAiHealth(storeId): Promise<AiHealthCheckResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:254

Check AI service health

Parameters

storeId

string

Store ID

Returns

Promise<AiHealthCheckResponse>

Health check status

---

create()

create(storeId, data): Promise<Policy>

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

Create a new policy

Parameters

storeId

string

data

CreatePolicyInput

Returns

Promise<Policy>

---

createPolicy()

createPolicy(storeId, data): Promise<Policy>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:89

Parameters

storeId

string

data

CreatePolicyInput

Returns

Promise<Policy>

Deprecated

Use create() instead

---

delete()

delete(storeId, idOrType): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:63

Delete a policy

Parameters

storeId

string

idOrType

string

Returns

Promise<DeletedResponse>

---

deletePolicy()

deletePolicy(storeId, type): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:103

Parameters

storeId

string

type

string

Returns

Promise<DeletedResponse>

Deprecated

Use delete() instead

---

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

---

generateWithAi()

generateWithAi(storeId, data): Promise<GenerateAiPolicyResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:165

Generate policy content using AI

Parameters

storeId

string

Store ID

data

GenerateAiPolicyInput

Policy generation parameters

Returns

Promise<GenerateAiPolicyResponse>

Generated policy with usage stats

---

generateWithAiStream()

generateWithAiStream(storeId, data): AsyncGenerator<string, void, unknown>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:193

Generate policy content using AI with streaming

Uses SDK streaming support for SSE responses. Yields content chunks as they arrive from the AI.

Parameters

storeId

string

Store ID

data

GenerateAiPolicyInput

Policy generation parameters

Returns

AsyncGenerator<string, void, unknown>

AsyncGenerator that yields content chunks

Example

for await (const chunk of tanqory.policies.generateWithAiStream(storeId, data)) {
  setContent(prev => prev + chunk)
}

---

getCollections()

getCollections(storeId): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:268

Get collections for final sale configuration

Parameters

storeId

string

Returns

Promise<object[]>

---

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

---

getPolicies()

getPolicies(storeId): Promise<Policy[]>

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

Parameters

storeId

string

Returns

Promise<Policy[]>

Deprecated

Use list() instead

---

getPolicy()

getPolicy(storeId, type): Promise<Policy>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:82

Parameters

storeId

string

type

string

Returns

Promise<Policy>

Deprecated

Use retrieve() instead

---

getReturnRules()

getReturnRules(storeId): Promise<ReturnRuleSetting>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:128

Get return rules for a store

Parameters

storeId

string

Returns

Promise<ReturnRuleSetting>

---

getTemplate()

getTemplate(type): Promise<{ content: string; title: string; type: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:114

Get policy template by type

Parameters

type

string

Returns

Promise<{ content: string; title: string; type: string; }>

---

list()

list(storeId): Promise<ListResponse<Policy>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:31

List all policies for a store

Parameters

storeId

string

Returns

Promise<ListResponse<Policy>>

---

retrieve()

retrieve(storeId, idOrType): Promise<Policy>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:38

Get a single policy by ID or type

Parameters

storeId

string

idOrType

string

Returns

Promise<Policy>

---

searchProducts()

searchProducts(storeId, query): Promise<object[]>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:280

Search products for final sale configuration

Parameters

storeId

string

query

string

Returns

Promise<object[]>

---

update()

update(storeId, idOrType, data): Promise<Policy>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:54

Update an existing policy

Parameters

storeId

string

idOrType

string

data

UpdatePolicyInput

Returns

Promise<Policy>

---

updatePolicy()

updatePolicy(storeId, type, data): Promise<Policy>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:96

Parameters

storeId

string

type

string

data

UpdatePolicyInput

Returns

Promise<Policy>

Deprecated

Use update() instead

---

updateReturnRules()

updateReturnRules(storeId, data): Promise<ReturnRuleSetting>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/policies.ts:141

Update return rules

Parameters

storeId

string

data

UpdateReturnRulesInput

Returns

Promise<ReturnRuleSetting>