docs: added entity reference (#2047)
* added entity reference * chore: added github action * added link to reference
This commit is contained in:
185
docs/content/references/entities/classes/ShippingMethod.md
Normal file
185
docs/content/references/entities/classes/ShippingMethod.md
Normal file
@@ -0,0 +1,185 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ShippingMethod
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ShippingMethod**()
|
||||
|
||||
## Properties
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order
|
||||
|
||||
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order\_id
|
||||
|
||||
• **claim\_order\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:90](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### price
|
||||
|
||||
• **price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:87](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
### return\_id
|
||||
|
||||
• **return\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:71](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
### return\_order
|
||||
|
||||
• **return\_order**: [`Return`](Return.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:75](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_option
|
||||
|
||||
• **shipping\_option**: [`ShippingOption`](ShippingOption.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:79](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_option\_id
|
||||
|
||||
• **shipping\_option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
### swap
|
||||
|
||||
• **swap**: [`Swap`](Swap.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
### swap\_id
|
||||
|
||||
• **swap\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
### tax\_lines
|
||||
|
||||
• **tax\_lines**: [`ShippingMethodTaxLine`](ShippingMethodTaxLine.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:84](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L84)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-method.ts#L92)
|
||||
Reference in New Issue
Block a user