Skip to main content

Class: AdminPublishableApiKeyResource

Hierarchy

  • default

    AdminPublishableApiKeyResource

Methods

addSalesChannelsBatch

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

Parameters

NameType
idstring
payloadAdminPostPublishableApiKeySalesChannelsBatchReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPublishableApiKeysRes>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:82


create

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

Parameters

NameType
payloadAdminPostPublishableApiKeysReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPublishableApiKeysRes>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:49


delete

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

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:66


deleteSalesChannelsBatch

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

Parameters

NameType
idstring
payloadAdminDeletePublishableApiKeySalesChannelsBatchReq
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPublishableApiKeysRes>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:91


list

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

Parameters

NameType
query?GetPublishableApiKeysParams
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPublishableApiKeysListRes>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:35


listSalesChannels

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

Parameters

NameType
idstring
query?GetPublishableApiKeySalesChannelsParams
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminSalesChannelsListRes>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:100


retrieve

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

Parameters

NameType
idstring
query?Object
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPublishableApiKeysRes>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:20


revoke

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

Parameters

NameType
idstring
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPublishableApiKeysRes>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:74


update

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

Parameters

NameType
idstring
payloadAdminPostPublishableApiKeysPublishableApiKeyReq
customHeadersRecord<string, any>

Returns

Promise<any>

Defined in

medusa-js/src/resources/admin/publishable-api-keys.ts:57