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
4.3 KiB
Class: AdminShippingOptionsResource
Hierarchy
-
default↳
AdminShippingOptionsResource
Methods
create
▸ create(payload, customHeaders?): ResponsePromise<AdminShippingOptionsRes>
Description
creates a shipping option.
Parameters
| Name | Type |
|---|---|
payload |
AdminPostShippingOptionsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminShippingOptionsRes>
created shipping option.
Defined in
medusa-js/src/resources/admin/shipping-options.ts:20
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
Description
deletes a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of shipping option to delete. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
deleted response
Defined in
medusa-js/src/resources/admin/shipping-options.ts:50
list
▸ list(query?, customHeaders?): ResponsePromise<AdminShippingOptionsListRes>
Description
lists shipping options matching a query
Parameters
| Name | Type | Description |
|---|---|---|
query? |
AdminGetShippingOptionsParams |
query for searching shipping options |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminShippingOptionsListRes>
a list of shipping options matching the query.
Defined in
medusa-js/src/resources/admin/shipping-options.ts:78
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminShippingOptionsRes>
Description
get a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the shipping option to retrieve. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminShippingOptionsRes>
the shipping option with the given id
Defined in
medusa-js/src/resources/admin/shipping-options.ts:64
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminShippingOptionsRes>
Description
updates a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the shipping option to update. |
payload |
AdminPostShippingOptionsOptionReq |
update to apply to shipping option. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminShippingOptionsRes>
the updated shipping option.