docs: added reference for JS Client (#1629)

* added reference for JS Client * added reference for JS Client * added reference for JS Client
2022-07-08 18:21:46 +03:00
parent 371682b4f7
commit 3b28f46705
357 changed files with 32911 additions and 3 deletions
--- a/docs/content/references/js-client/classes/internal.ShippingOption.md
+++ b/docs/content/references/js-client/classes/internal.ShippingOption.md
@@ -0,0 +1,219 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Class: ShippingOption
+
+[internal](../modules/internal.md).ShippingOption
+
+## Hierarchy
+
+- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md)
+
+  ↳ **`ShippingOption`**
+
+## Properties
+
+### admin\_only
+
+• **admin\_only**: `boolean`
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:21
+
+___
+
+### amount
+
+• **amount**: `number`
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:19
+
+___
+
+### beforeInsert
+
+• `Private` **beforeInsert**: `any`
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:25
+
+___
+
+### created\_at
+
+• **created\_at**: [`Date`](../modules/internal.md#date)
+
+#### Inherited from
+
+[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at)
+
+#### Defined in
+
+packages/medusa/dist/interfaces/models/base-entity.d.ts:6
+
+___
+
+### data
+
+• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:23
+
+___
+
+### deleted\_at
+
+• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date)
+
+#### Inherited from
+
+[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at)
+
+#### Defined in
+
+packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Inherited from
+
+[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id)
+
+#### Defined in
+
+packages/medusa/dist/interfaces/models/base-entity.d.ts:5
+
+___
+
+### is\_return
+
+• **is\_return**: `boolean`
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:20
+
+___
+
+### metadata
+
+• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:24
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:11
+
+___
+
+### price\_type
+
+• **price\_type**: [`ShippingOptionPriceType`](../enums/internal.ShippingOptionPriceType.md)
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:18
+
+___
+
+### profile
+
+• **profile**: [`ShippingProfile`](internal.ShippingProfile.md)
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:15
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:14
+
+___
+
+### provider
+
+• **provider**: [`FulfillmentProvider`](internal.FulfillmentProvider.md)
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:17
+
+___
+
+### provider\_id
+
+• **provider\_id**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:16
+
+___
+
+### region
+
+• **region**: [`Region`](internal.Region.md)
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:13
+
+___
+
+### region\_id
+
+• **region\_id**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:12
+
+___
+
+### requirements
+
+• **requirements**: [`ShippingOptionRequirement`](internal.ShippingOptionRequirement.md)[]
+
+#### Defined in
+
+packages/medusa/dist/models/shipping-option.d.ts:22
+
+___
+
+### updated\_at
+
+• **updated\_at**: [`Date`](../modules/internal.md#date)
+
+#### Inherited from
+
+[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at)
+
+#### Defined in
+
+packages/medusa/dist/interfaces/models/base-entity.d.ts:7