4.2 KiB
Class: AdminPublishableApiKeyResource
Hierarchy
-
default↳
AdminPublishableApiKeyResource
Methods
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:45
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:62
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:31
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:16
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:70
update
▸ update(id, payload, customHeaders?): Promise<any>
Parameters
| Name | Type |
|---|---|
id |
string |
payload |
AdminPostPublishableApiKeysPublishableApiKeyReq |
customHeaders |
Record<string, any> |
Returns
Promise<any>