Class: CustomerComputedTraitsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-computed-traits.ts:19

Extends

• BaseService

Constructors

Constructor

new CustomerComputedTraitsService(client): CustomerComputedTraitsService

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

Parameters

client

TanqoryClient

Returns

CustomerComputedTraitsService

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

---

createComputedTrait()

createComputedTrait(storeId, data): Promise<{ config: { aggregation?: "count" | "min" | "max" | "sum" | "avg" | "first" | "last"; customExpression?: string; eventName?: string; propertyName?: string; timeWindowDays?: number; }; description?: string; id: string; isActive: boolean; lastRefreshAt?: Date; name: string; refreshIntervalHrs: number; type: "custom" | "event_count" | "event_sum" | "event_avg" | "first_value" | "last_value" | "most_frequent" | "unique_list"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-computed-traits.ts:54

Create a computed trait

Parameters

storeId

string

data

config

{ aggregation?: "count" | "min" | "max" | "sum" | "avg" | "first" | "last"; customExpression?: string; eventName?: string; propertyName?: string; timeWindowDays?: number; }

config.aggregation?

"count" | "min" | "max" | "sum" | "avg" | "first" | "last"

config.customExpression?

string

config.eventName?

string

config.propertyName?

string

config.timeWindowDays?

number

description?

string

name

string

refreshIntervalHrs

number

type

"custom" | "event_count" | "event_sum" | "event_avg" | "first_value" | "last_value" | "most_frequent" | "unique_list"

Returns

Promise<{ config: { aggregation?: "count" | "min" | "max" | "sum" | "avg" | "first" | "last"; customExpression?: string; eventName?: string; propertyName?: string; timeWindowDays?: number; }; description?: string; id: string; isActive: boolean; lastRefreshAt?: Date; name: string; refreshIntervalHrs: number; type: "custom" | "event_count" | "event_sum" | "event_avg" | "first_value" | "last_value" | "most_frequent" | "unique_list"; }>

---

deleteComputedTrait()

deleteComputedTrait(storeId, traitId): Promise<{ deleted: true; id: string; object: "computed_trait"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-computed-traits.ts:86

Delete a computed trait

Parameters

storeId

string

traitId

string

Returns

Promise<{ deleted: true; id: string; object: "computed_trait"; }>

---

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

---

listComputedTraits()

listComputedTraits(storeId, params?): Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-computed-traits.ts:27

List computed traits

Parameters

storeId

string

params?

isActive?

boolean

limit?

number

page?

number

search?

string

Returns

Promise<{ data: object[]; limit: number; page: number; total: number; total_pages: number; }>

---

refreshComputedTrait()

refreshComputedTrait(storeId, traitId): Promise<{ affectedCustomers: number; lastRefreshAt: Date; success: boolean; traitId: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-computed-traits.ts:99

Refresh computed trait values

Parameters

storeId

string

traitId

string

Returns

Promise<{ affectedCustomers: number; lastRefreshAt: Date; success: boolean; traitId: string; }>

---

retrieveComputedTrait()

retrieveComputedTrait(storeId, traitId): Promise<{ config: { aggregation?: "count" | "min" | "max" | "sum" | "avg" | "first" | "last"; customExpression?: string; eventName?: string; propertyName?: string; timeWindowDays?: number; }; description?: string; id: string; isActive: boolean; lastRefreshAt?: Date; name: string; refreshIntervalHrs: number; type: "custom" | "event_count" | "event_sum" | "event_avg" | "first_value" | "last_value" | "most_frequent" | "unique_list"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-computed-traits.ts:41

Get a computed trait

Parameters

storeId

string

traitId

string

Returns

Promise<{ config: { aggregation?: "count" | "min" | "max" | "sum" | "avg" | "first" | "last"; customExpression?: string; eventName?: string; propertyName?: string; timeWindowDays?: number; }; description?: string; id: string; isActive: boolean; lastRefreshAt?: Date; name: string; refreshIntervalHrs: number; type: "custom" | "event_count" | "event_sum" | "event_avg" | "first_value" | "last_value" | "most_frequent" | "unique_list"; }>

---

updateComputedTrait()

updateComputedTrait(storeId, traitId, data): Promise<{ config: { aggregation?: "count" | "min" | "max" | "sum" | "avg" | "first" | "last"; customExpression?: string; eventName?: string; propertyName?: string; timeWindowDays?: number; }; description?: string; id: string; isActive: boolean; lastRefreshAt?: Date; name: string; refreshIntervalHrs: number; type: "custom" | "event_count" | "event_sum" | "event_avg" | "first_value" | "last_value" | "most_frequent" | "unique_list"; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/customer-computed-traits.ts:71

Update a computed trait

Parameters

storeId

string

traitId

string

data

config?

{ aggregation?: "count" | "min" | "max" | "sum" | "avg" | "first" | "last"; customExpression?: string; eventName?: string; propertyName?: string; timeWindowDays?: number; }

config.aggregation?

"count" | "min" | "max" | "sum" | "avg" | "first" | "last"

config.customExpression?

string

config.eventName?

string

config.propertyName?

string

config.timeWindowDays?

number

description?

string

isActive?

boolean

name?

string

refreshIntervalHrs?

number

type?

"custom" | "event_count" | "event_sum" | "event_avg" | "first_value" | "last_value" | "most_frequent" | "unique_list"

Returns

Promise<{ config: { aggregation?: "count" | "min" | "max" | "sum" | "avg" | "first" | "last"; customExpression?: string; eventName?: string; propertyName?: string; timeWindowDays?: number; }; description?: string; id: string; isActive: boolean; lastRefreshAt?: Date; name: string; refreshIntervalHrs: number; type: "custom" | "event_count" | "event_sum" | "event_avg" | "first_value" | "last_value" | "most_frequent" | "unique_list"; }>