docs: added entity reference (#2047)

* added entity reference * chore: added github action * added link to reference
2022-08-15 15:54:48 +03:00
parent 4a89961fd4
commit 4a416e7fa5
101 changed files with 12704 additions and 4 deletions
--- a/docs/content/references/entities/classes/CustomShippingOption.md
+++ b/docs/content/references/entities/classes/CustomShippingOption.md
@@ -0,0 +1,151 @@
+---
+displayed_sidebar: entitiesSidebar
+---
+
+# Class: CustomShippingOption
+
+## Hierarchy
+
+- `SoftDeletableEntity`
+
+  ↳ **`CustomShippingOption`**
+
+## Constructors
+
+### constructor
+
+• **new CustomShippingOption**()
+
+#### Inherited from
+
+SoftDeletableEntity.constructor
+
+## Properties
+
+### cart
+
+• **cart**: [`Cart`](Cart.md)
+
+#### Defined in
+
+[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L37)
+
+___
+
+### cart\_id
+
+• **cart\_id**: `string`
+
+#### Defined in
+
+[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L33)
+
+___
+
+### created\_at
+
+• **created\_at**: `Date`
+
+#### Inherited from
+
+SoftDeletableEntity.created\_at
+
+#### Defined in
+
+[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L16)
+
+___
+
+### deleted\_at
+
+• **deleted\_at**: ``null`` \| `Date`
+
+#### Inherited from
+
+SoftDeletableEntity.deleted\_at
+
+#### Defined in
+
+[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Inherited from
+
+SoftDeletableEntity.id
+
+#### Defined in
+
+[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L13)
+
+___
+
+### metadata
+
+• **metadata**: `Record`<`string`, `unknown`\>
+
+#### Defined in
+
+[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L40)
+
+___
+
+### price
+
+• **price**: `number`
+
+#### Defined in
+
+[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L21)
+
+___
+
+### shipping\_option
+
+• **shipping\_option**: [`ShippingOption`](ShippingOption.md)
+
+#### Defined in
+
+[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L29)
+
+___
+
+### shipping\_option\_id
+
+• **shipping\_option\_id**: `string`
+
+#### Defined in
+
+[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L25)
+
+___
+
+### updated\_at
+
+• **updated\_at**: `Date`
+
+#### Inherited from
+
+SoftDeletableEntity.updated\_at
+
+#### Defined in
+
+[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/interfaces/models/base-entity.ts#L19)
+
+## Methods
+
+### beforeInsert
+
+▸ `Private` **beforeInsert**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/custom-shipping-option.ts#L42)