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.Product.md
+++ b/docs/content/references/js-client/classes/internal.Product.md
@@ -0,0 +1,359 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Class: Product
+
+[internal](../modules/internal.md).Product
+
+## Hierarchy
+
+- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md)
+
+  ↳ **`Product`**
+
+## Properties
+
+### beforeInsert
+
+• `Private` **beforeInsert**: `any`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:44
+
+___
+
+### collection
+
+• **collection**: [`ProductCollection`](internal.ProductCollection.md)
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:37
+
+___
+
+### collection\_id
+
+• **collection\_id**: ``null`` \| `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:36
+
+___
+
+### 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
+
+___
+
+### 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
+
+___
+
+### description
+
+• **description**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:18
+
+___
+
+### discountable
+
+• **discountable**: `boolean`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:41
+
+___
+
+### external\_id
+
+• **external\_id**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:42
+
+___
+
+### handle
+
+• **handle**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:19
+
+___
+
+### height
+
+• **height**: `number`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:30
+
+___
+
+### hs\_code
+
+• **hs\_code**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:32
+
+___
+
+### 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
+
+___
+
+### images
+
+• **images**: [`Image`](internal.Image.md)[]
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:22
+
+___
+
+### is\_giftcard
+
+• **is\_giftcard**: `boolean`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:20
+
+___
+
+### length
+
+• **length**: `number`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:29
+
+___
+
+### material
+
+• **material**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:35
+
+___
+
+### metadata
+
+• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:43
+
+___
+
+### mid\_code
+
+• **mid\_code**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:34
+
+___
+
+### options
+
+• **options**: [`ProductOption`](internal.ProductOption.md)[]
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:24
+
+___
+
+### origin\_country
+
+• **origin\_country**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:33
+
+___
+
+### profile
+
+• **profile**: [`ShippingProfile`](internal.ShippingProfile.md)
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:27
+
+___
+
+### profile\_id
+
+• **profile\_id**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:26
+
+___
+
+### status
+
+• **status**: [`Status`](../enums/internal.Status.md)
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:21
+
+___
+
+### subtitle
+
+• **subtitle**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:17
+
+___
+
+### tags
+
+• **tags**: [`ProductTag`](internal.ProductTag.md)[]
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:40
+
+___
+
+### thumbnail
+
+• **thumbnail**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:23
+
+___
+
+### title
+
+• **title**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:16
+
+___
+
+### type
+
+• **type**: [`ProductType`](internal.ProductType.md)
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:39
+
+___
+
+### type\_id
+
+• **type\_id**: `string`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:38
+
+___
+
+### 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
+
+___
+
+### variants
+
+• **variants**: [`ProductVariant`](internal.ProductVariant.md)[]
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:25
+
+___
+
+### weight
+
+• **weight**: `number`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:28
+
+___
+
+### width
+
+• **width**: `number`
+
+#### Defined in
+
+packages/medusa/dist/models/product.d.ts:31