fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
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>