Class: AdminPublishableApiKeyResource
Hierarchy
defaultCopy to Clipboard↳
AdminPublishableApiKeyResourceCopy to Clipboard
Methods
addSalesChannelsBatch
▸ addSalesChannelsBatch(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostPublishableApiKeySalesChannelsBatchReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:82
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostPublishableApiKeysReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:49
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:66
deleteSalesChannelsBatch
▸ deleteSalesChannelsBatch(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminDeletePublishableApiKeySalesChannelsBatchReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:91
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | GetPublishableApiKeysParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:35
listSalesChannels
▸ listSalesChannels(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminSalesChannelsListResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
query?Copy to Clipboard | GetPublishableApiKeySalesChannelsParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminSalesChannelsListResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:100
retrieve
▸ retrieve(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
query?Copy to Clipboard | ObjectCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:20
revoke
▸ revoke(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPublishableApiKeysResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:74
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): PromiseCopy to Clipboard<anyCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostPublishableApiKeysPublishableApiKeyReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
PromiseCopy to Clipboard<anyCopy to Clipboard>