Class: WebhooksService

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

Extends

• BaseService

Constructors

Constructor

new WebhooksService(client): WebhooksService

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

Parameters

client

TanqoryClient

Returns

WebhooksService

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<{ createdAt: Date; events: string[]; headers?: Record<string, string>; id: string; isActive: boolean; metadata?: Record<string, any>; secret?: string; storeId: string; updatedAt: Date; url: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/webhooks.ts:27

Parameters

storeId

string

data

events

string[]

headers?

Record<string, string>

isActive

boolean

metadata?

Record<string, any>

secret?

string

url

string

Returns

Promise<{ createdAt: Date; events: string[]; headers?: Record<string, string>; id: string; isActive: boolean; metadata?: Record<string, any>; secret?: string; storeId: string; updatedAt: Date; url: string; }>

---

delete()

delete(storeId, webhookId): Promise<void>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/webhooks.ts:40

Parameters

storeId

string

webhookId

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

---

list()

list(storeId, options?): Promise<PaginatedResponse<{ createdAt: Date; events: string[]; headers?: Record<string, string>; id: string; isActive: boolean; metadata?: Record<string, any>; secret?: string; storeId: string; updatedAt: Date; url: string; }>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/webhooks.ts:17

Parameters

storeId

string

options?

ListOptions

Returns

Promise<PaginatedResponse<{ createdAt: Date; events: string[]; headers?: Record<string, string>; id: string; isActive: boolean; metadata?: Record<string, any>; secret?: string; storeId: string; updatedAt: Date; url: string; }>>

---

retrieve()

retrieve(storeId, webhookId): Promise<{ createdAt: Date; events: string[]; headers?: Record<string, string>; id: string; isActive: boolean; metadata?: Record<string, any>; secret?: string; storeId: string; updatedAt: Date; url: string; }>

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

Parameters

storeId

string

webhookId

string

Returns

Promise<{ createdAt: Date; events: string[]; headers?: Record<string, string>; id: string; isActive: boolean; metadata?: Record<string, any>; secret?: string; storeId: string; updatedAt: Date; url: string; }>

---

test()

test(storeId, webhookId): Promise<any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/webhooks.ts:44

Parameters

storeId

string

webhookId

string

Returns

Promise<any>

---

update()

update(storeId, webhookId, data): Promise<{ createdAt: Date; events: string[]; headers?: Record<string, string>; id: string; isActive: boolean; metadata?: Record<string, any>; secret?: string; storeId: string; updatedAt: Date; url: string; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/webhooks.ts:34

Parameters

storeId

string

webhookId

string

data

events?

string[]

headers?

Record<string, string>

isActive?

boolean

metadata?

Record<string, any>

secret?

string

url?

string

Returns

Promise<{ createdAt: Date; events: string[]; headers?: Record<string, string>; id: string; isActive: boolean; metadata?: Record<string, any>; secret?: string; storeId: string; updatedAt: Date; url: string; }>