AdminPublishableApiKeyResource

admin/publishable-api-keys.AdminPublishableApiKeyResource

Methods

addSalesChannelsBatch

addSalesChannelsBatch(id, payload, customHeaders?): ResponsePromise<AdminPublishableApiKeysRes>

Parameters

idstringRequired

payloadAdminPostPublishableApiKeySalesChannelsBatchReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminPublishableApiKeysRes>

ResponsePromiseResponsePromise<AdminPublishableApiKeysRes>Required

---

create

create(payload, customHeaders?): ResponsePromise<AdminPublishableApiKeysRes>

Parameters

payloadAdminPostPublishableApiKeysReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminPublishableApiKeysRes>

ResponsePromiseResponsePromise<AdminPublishableApiKeysRes>Required

---

delete

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

---

deleteSalesChannelsBatch

deleteSalesChannelsBatch(id, payload, customHeaders?): ResponsePromise<AdminPublishableApiKeysRes>

Parameters

idstringRequired

payloadAdminDeletePublishableApiKeySalesChannelsBatchReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminPublishableApiKeysRes>

ResponsePromiseResponsePromise<AdminPublishableApiKeysRes>Required

---

list

list(query?, customHeaders?): ResponsePromise<AdminPublishableApiKeysListRes>

Parameters

queryGetPublishableApiKeysParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminPublishableApiKeysListRes>

ResponsePromiseResponsePromise<AdminPublishableApiKeysListRes>Required

---

listSalesChannels

listSalesChannels(id, query?, customHeaders?): ResponsePromise<AdminSalesChannelsListRes>

Parameters

idstringRequired

queryGetPublishableApiKeySalesChannelsParams

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminSalesChannelsListRes>

ResponsePromiseResponsePromise<AdminSalesChannelsListRes>Required

---

retrieve

retrieve(id, query?, customHeaders?): ResponsePromise<AdminPublishableApiKeysRes>

Parameters

idstringRequired

queryobject

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminPublishableApiKeysRes>

ResponsePromiseResponsePromise<AdminPublishableApiKeysRes>Required

---

revoke

revoke(id, customHeaders?): ResponsePromise<AdminPublishableApiKeysRes>

Parameters

idstringRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminPublishableApiKeysRes>

ResponsePromiseResponsePromise<AdminPublishableApiKeysRes>Required

---

update

update(id, payload, customHeaders?): Promise<any>

Parameters

idstringRequired

payloadAdminPostPublishableApiKeysPublishableApiKeyReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

Promise<any>

PromisePromise<any>Required