Skip to main content

Class: PixelsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:9

Extends​

  • BaseService

Constructors​

Constructor​

new PixelsService(client): PixelsService

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

Parameters​

client​

TanqoryClient

Returns​

PixelsService

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

create()​

create(storeId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:29

Create a new pixels item

Parameters​

storeId​

string

data​

any

Returns​

Promise<any>

createPixel()​

createPixel(storeId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:76

Create pixel

Parameters​

storeId​

string

data​

any

Returns​

Promise<any>

delete()​

delete(id, storeId): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:47

Delete a pixels item

Parameters​

id​

string

storeId​

string

Returns​

Promise<void>

deletePixel()​

deletePixel(storeId, pixelId): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:94

Delete pixel

Parameters​

storeId​

string

pixelId​

string

Returns​

Promise<void>

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

getPixelById()​

getPixelById(storeId, pixelId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:67

Get pixel by ID Cache disabled - data should always be fresh after mutations

Parameters​

storeId​

string

pixelId​

string

Returns​

Promise<any>

getPixels()​

getPixels(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:57

Get all pixels for a store Cache disabled - data should always be fresh after mutations

Parameters​

storeId​

string

Returns​

Promise<any>

getStats()​

getStats(storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:101

Get pixel stats

Parameters​

storeId​

string

Returns​

Promise<any>

list()​

list(storeId, options?): Promise<PaginatedResponse<any>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:13

List all pixels items

Parameters​

storeId​

string

options?​

ListOptions

Returns​

Promise<PaginatedResponse<any>>

retrieve()​

retrieve(id, storeId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:22

Get a single pixels item by ID

Parameters​

id​

string

storeId​

string

Returns​

Promise<any>

update()​

update(id, storeId, data): Promise<any>

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

Update an existing pixels item

Parameters​

id​

string

storeId​

string

data​

any

Returns​

Promise<any>

updatePixel()​

updatePixel(storeId, pixelId, data): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/pixels.ts:85

Update pixel

Parameters​

storeId​

string

pixelId​

string

data​

any

Returns​

Promise<any>