6.7 KiB
Class: AdminPublishableApiKeyResource
Hierarchy
-
default↳
AdminPublishableApiKeyResource
Methods
addSalesChannelsBatch
▸ addSalesChannelsBatch(id, payload, customHeaders?): ResponsePromise<AdminPublishableApiKeysRes>
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostPublishableApiKeySalesChannelsBatchReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminPublishableApiKeysRes>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:82
create
▸ create(payload, customHeaders?): ResponsePromise<AdminPublishableApiKeysRes>
Parameters
| Name | Type |
|---|---|
payload |
AdminPostPublishableApiKeysReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminPublishableApiKeysRes>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:49
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<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
| Name | Type |
|---|---|
id |
string |
payload |
AdminDeletePublishableApiKeySalesChannelsBatchReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminPublishableApiKeysRes>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:91
list
▸ list(query?, customHeaders?): ResponsePromise<AdminPublishableApiKeysListRes>
Parameters
| Name | Type |
|---|---|
query? |
GetPublishableApiKeysParams |
customHeaders |
Record<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
| Name | Type |
|---|---|
id |
string |
query? |
GetPublishableApiKeySalesChannelsParams |
customHeaders |
Record<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
| Name | Type |
|---|---|
id |
string |
query? |
Object |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminPublishableApiKeysRes>
Defined in
medusa-js/src/resources/admin/publishable-api-keys.ts:20
revoke
▸ revoke(id, customHeaders?): ResponsePromise<AdminPublishableApiKeysRes>
Parameters
| Name | Type |
|---|---|
id |
string |
customHeaders |
Record<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
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostPublishableApiKeysPublishableApiKeyReq |
customHeaders |
Record<string, any> |
Returns
Promise<any>