docs: create docs workspace (#5174)
* 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
This commit is contained in:
@@ -0,0 +1,225 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ShippingMethod
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ShippingMethod**()
|
||||
|
||||
## Properties
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:61](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:57](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order
|
||||
|
||||
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:53](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order\_id
|
||||
|
||||
• **claim\_order\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:49](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L92)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:33](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### includes\_tax
|
||||
|
||||
• **includes\_tax**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:95](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L95)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:45](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:41](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:89](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
### return\_id
|
||||
|
||||
• **return\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:73](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
### return\_order
|
||||
|
||||
• **return\_order**: [`Return`](Return.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:77](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_option
|
||||
|
||||
• **shipping\_option**: [`ShippingOption`](ShippingOption.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:81](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_option\_id
|
||||
|
||||
• **shipping\_option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:37](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### subtotal
|
||||
|
||||
• `Optional` **subtotal**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:97](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
### swap
|
||||
|
||||
• **swap**: [`Swap`](Swap.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:69](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### swap\_id
|
||||
|
||||
• **swap\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:65](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### tax\_lines
|
||||
|
||||
• **tax\_lines**: [`ShippingMethodTaxLine`](ShippingMethodTaxLine.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:86](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L86)
|
||||
|
||||
___
|
||||
|
||||
### tax\_total
|
||||
|
||||
• `Optional` **tax\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:99](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L99)
|
||||
|
||||
___
|
||||
|
||||
### total
|
||||
|
||||
• `Optional` **total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:98](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L98)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:101](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/shipping-method.ts#L101)
|
||||
Reference in New Issue
Block a user