docs: update override price selection strategy documentation (#5438)
* docs: update override price selection strategy documentation * fix eslint errors
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
8bc902fb0f
commit
1a10822cae
540 files changed
+244366
-18865
No files matched your search
@@ -0,0 +1,119 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Entities Reference
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [AllocationType](enums/AllocationType.mdx)
|
||||
- [CartType](enums/CartType.mdx)
|
||||
- [ClaimFulfillmentStatus](enums/ClaimFulfillmentStatus.mdx)
|
||||
- [ClaimPaymentStatus](enums/ClaimPaymentStatus.mdx)
|
||||
- [ClaimReason](enums/ClaimReason.mdx)
|
||||
- [ClaimType](enums/ClaimType.mdx)
|
||||
- [DiscountConditionOperator](enums/DiscountConditionOperator.mdx)
|
||||
- [DiscountConditionType](enums/DiscountConditionType.mdx)
|
||||
- [DiscountRuleType](enums/DiscountRuleType.mdx)
|
||||
- [DraftOrderStatus](enums/DraftOrderStatus.mdx)
|
||||
- [FulfillmentStatus](enums/FulfillmentStatus.mdx)
|
||||
- [OrderEditItemChangeType](enums/OrderEditItemChangeType.mdx)
|
||||
- [OrderEditStatus](enums/OrderEditStatus.mdx)
|
||||
- [OrderStatus](enums/OrderStatus.mdx)
|
||||
- [PaymentCollectionStatus](enums/PaymentCollectionStatus.mdx)
|
||||
- [PaymentCollectionType](enums/PaymentCollectionType.mdx)
|
||||
- [PaymentSessionStatus](enums/PaymentSessionStatus.mdx)
|
||||
- [PaymentStatus](enums/PaymentStatus.mdx)
|
||||
- [ProductStatus](enums/ProductStatus.mdx)
|
||||
- [RefundReason](enums/RefundReason.mdx)
|
||||
- [RequirementType](enums/RequirementType.mdx)
|
||||
- [ReturnStatus](enums/ReturnStatus.mdx)
|
||||
- [ShippingOptionPriceType](enums/ShippingOptionPriceType.mdx)
|
||||
- [ShippingProfileType](enums/ShippingProfileType.mdx)
|
||||
- [SwapFulfillmentStatus](enums/SwapFulfillmentStatus.mdx)
|
||||
- [SwapPaymentStatus](enums/SwapPaymentStatus.mdx)
|
||||
- [UserRoles](enums/UserRoles.mdx)
|
||||
|
||||
## Classes
|
||||
|
||||
- [Address](classes/Address.mdx)
|
||||
- [AnalyticsConfig](classes/AnalyticsConfig.mdx)
|
||||
- [BatchJob](classes/BatchJob.mdx)
|
||||
- [Cart](classes/Cart.mdx)
|
||||
- [ClaimImage](classes/ClaimImage.mdx)
|
||||
- [ClaimItem](classes/ClaimItem.mdx)
|
||||
- [ClaimOrder](classes/ClaimOrder.mdx)
|
||||
- [ClaimTag](classes/ClaimTag.mdx)
|
||||
- [Country](classes/Country.mdx)
|
||||
- [Currency](classes/Currency.mdx)
|
||||
- [CustomShippingOption](classes/CustomShippingOption.mdx)
|
||||
- [Customer](classes/Customer.mdx)
|
||||
- [CustomerGroup](classes/CustomerGroup.mdx)
|
||||
- [Discount](classes/Discount.mdx)
|
||||
- [DiscountCondition](classes/DiscountCondition.mdx)
|
||||
- [DiscountConditionCustomerGroup](classes/DiscountConditionCustomerGroup.mdx)
|
||||
- [DiscountConditionProduct](classes/DiscountConditionProduct.mdx)
|
||||
- [DiscountConditionProductCollection](classes/DiscountConditionProductCollection.mdx)
|
||||
- [DiscountConditionProductTag](classes/DiscountConditionProductTag.mdx)
|
||||
- [DiscountConditionProductType](classes/DiscountConditionProductType.mdx)
|
||||
- [DiscountRule](classes/DiscountRule.mdx)
|
||||
- [DraftOrder](classes/DraftOrder.mdx)
|
||||
- [Fulfillment](classes/Fulfillment.mdx)
|
||||
- [FulfillmentItem](classes/FulfillmentItem.mdx)
|
||||
- [FulfillmentProvider](classes/FulfillmentProvider.mdx)
|
||||
- [GiftCard](classes/GiftCard.mdx)
|
||||
- [GiftCardTransaction](classes/GiftCardTransaction.mdx)
|
||||
- [IdempotencyKey](classes/IdempotencyKey.mdx)
|
||||
- [Image](classes/Image.mdx)
|
||||
- [Invite](classes/Invite.mdx)
|
||||
- [LineItem](classes/LineItem.mdx)
|
||||
- [LineItemAdjustment](classes/LineItemAdjustment.mdx)
|
||||
- [LineItemTaxLine](classes/LineItemTaxLine.mdx)
|
||||
- [MoneyAmount](classes/MoneyAmount.mdx)
|
||||
- [Note](classes/Note.mdx)
|
||||
- [Notification](classes/Notification.mdx)
|
||||
- [Oauth](classes/Oauth.mdx)
|
||||
- [Order](classes/Order.mdx)
|
||||
- [OrderEdit](classes/OrderEdit.mdx)
|
||||
- [OrderItemChange](classes/OrderItemChange.mdx)
|
||||
- [Payment](classes/Payment.mdx)
|
||||
- [PaymentCollection](classes/PaymentCollection.mdx)
|
||||
- [PaymentProvider](classes/PaymentProvider.mdx)
|
||||
- [PaymentSession](classes/PaymentSession.mdx)
|
||||
- [PriceList](classes/PriceList.mdx)
|
||||
- [Product](classes/Product.mdx)
|
||||
- [ProductCategory](classes/ProductCategory.mdx)
|
||||
- [ProductCollection](classes/ProductCollection.mdx)
|
||||
- [ProductOption](classes/ProductOption.mdx)
|
||||
- [ProductOptionValue](classes/ProductOptionValue.mdx)
|
||||
- [ProductTag](classes/ProductTag.mdx)
|
||||
- [ProductTaxRate](classes/ProductTaxRate.mdx)
|
||||
- [ProductType](classes/ProductType.mdx)
|
||||
- [ProductTypeTaxRate](classes/ProductTypeTaxRate.mdx)
|
||||
- [ProductVariant](classes/ProductVariant.mdx)
|
||||
- [ProductVariantInventoryItem](classes/ProductVariantInventoryItem.mdx)
|
||||
- [ProductVariantMoneyAmount](classes/ProductVariantMoneyAmount.mdx)
|
||||
- [PublishableApiKey](classes/PublishableApiKey.mdx)
|
||||
- [PublishableApiKeySalesChannel](classes/PublishableApiKeySalesChannel.mdx)
|
||||
- [Refund](classes/Refund.mdx)
|
||||
- [Region](classes/Region.mdx)
|
||||
- [Return](classes/Return.mdx)
|
||||
- [ReturnItem](classes/ReturnItem.mdx)
|
||||
- [ReturnReason](classes/ReturnReason.mdx)
|
||||
- [SalesChannel](classes/SalesChannel.mdx)
|
||||
- [SalesChannelLocation](classes/SalesChannelLocation.mdx)
|
||||
- [ShippingMethod](classes/ShippingMethod.mdx)
|
||||
- [ShippingMethodTaxLine](classes/ShippingMethodTaxLine.mdx)
|
||||
- [ShippingOption](classes/ShippingOption.mdx)
|
||||
- [ShippingOptionRequirement](classes/ShippingOptionRequirement.mdx)
|
||||
- [ShippingProfile](classes/ShippingProfile.mdx)
|
||||
- [ShippingTaxRate](classes/ShippingTaxRate.mdx)
|
||||
- [StagedJob](classes/StagedJob.mdx)
|
||||
- [Store](classes/Store.mdx)
|
||||
- [Swap](classes/Swap.mdx)
|
||||
- [TaxProvider](classes/TaxProvider.mdx)
|
||||
- [TaxRate](classes/TaxRate.mdx)
|
||||
- [TrackingLink](classes/TrackingLink.mdx)
|
||||
- [User](classes/User.mdx)
|
||||
@@ -1,231 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Address
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`Address`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Address**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### address\_1
|
||||
|
||||
• **address\_1**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### address\_2
|
||||
|
||||
• **address\_2**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### city
|
||||
|
||||
• **city**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
### company
|
||||
|
||||
• **company**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
### country
|
||||
|
||||
• **country**: ``null`` \| [`Country`](Country.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### country\_code
|
||||
|
||||
• **country\_code**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### customer
|
||||
|
||||
• **customer**: ``null`` \| [`Customer`](Customer.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• **customer\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### 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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### first\_name
|
||||
|
||||
• **first\_name**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### last\_name
|
||||
|
||||
• **last\_name**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
### phone
|
||||
|
||||
• **phone**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
### postal\_code
|
||||
|
||||
• **postal\_code**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### province
|
||||
|
||||
• **province**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/address.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L64)
|
||||
@@ -0,0 +1,156 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Address
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "address_1",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "address_2",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "city",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "company",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country",
|
||||
"type": "``null`` \\| [`Country`](Country.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "country_code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customer",
|
||||
"type": "``null`` \\| [`Customer`](Customer.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "customer_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "first_name",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "last_name",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "phone",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "postal_code",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "province",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,121 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: AnalyticsConfig
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`AnalyticsConfig`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new AnalyticsConfig**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### anonymize
|
||||
|
||||
• **anonymize**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/analytics-config.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/analytics-config.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### opt\_out
|
||||
|
||||
• **opt\_out**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/analytics-config.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/analytics-config.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### user\_id
|
||||
|
||||
• **user\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/analytics-config.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/analytics-config.ts#L11)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/analytics-config.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/analytics-config.ts#L20)
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# AnalyticsConfig
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "anonymize",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "opt_out",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "user_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,249 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: BatchJob
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`BatchJob`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new BatchJob**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• `Optional` **canceled\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
### completed\_at
|
||||
|
||||
• `Optional` **completed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### confirmed\_at
|
||||
|
||||
• `Optional` **confirmed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### context
|
||||
|
||||
• **context**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### created\_by
|
||||
|
||||
• **created\_by**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### created\_by\_user
|
||||
|
||||
• **created\_by\_user**: [`User`](User.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
### 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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### dry\_run
|
||||
|
||||
• **dry\_run**: `boolean` = `false`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
### failed\_at
|
||||
|
||||
• `Optional` **failed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### pre\_processed\_at
|
||||
|
||||
• `Optional` **pre\_processed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### processing\_at
|
||||
|
||||
• `Optional` **processing\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### result
|
||||
|
||||
• **result**: { `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \| `BatchJobResultError`)[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[] } & `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: `BatchJobStatus`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L95)
|
||||
|
||||
___
|
||||
|
||||
### loadStatus
|
||||
|
||||
▸ **loadStatus**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
### toJSON
|
||||
|
||||
▸ **toJSON**(): [`BatchJob`](BatchJob.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`BatchJob`](BatchJob.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L99)
|
||||
@@ -0,0 +1,278 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# BatchJob
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "canceled_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "completed_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "confirmed_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_by",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_by_user",
|
||||
"type": "[`User`](User.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "constructor",
|
||||
"type": "() => [`User`](User.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "api_token",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "email",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "first_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "last_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "password_hash",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "role",
|
||||
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "ADMIN",
|
||||
"type": "``\"admin\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "DEVELOPER",
|
||||
"type": "``\"developer\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "MEMBER",
|
||||
"type": "``\"member\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "beforeInsert",
|
||||
"type": "() => `void`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "dry_run",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "`false`",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "failed_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "pre_processed_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "processing_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "result",
|
||||
"type": "{ `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \\| `BatchJobResultError`)[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[] } & Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "status",
|
||||
"type": "`BatchJobStatus`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "type",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,485 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Cart
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`Cart`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Cart**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### billing\_address
|
||||
|
||||
• **billing\_address**: [`Address`](Address.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:288](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L288)
|
||||
|
||||
___
|
||||
|
||||
### billing\_address\_id
|
||||
|
||||
• **billing\_address\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:282](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L282)
|
||||
|
||||
___
|
||||
|
||||
### completed\_at
|
||||
|
||||
• **completed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:373](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L373)
|
||||
|
||||
___
|
||||
|
||||
### context
|
||||
|
||||
• **context**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:382](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L382)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### customer
|
||||
|
||||
• **customer**: [`Customer`](Customer.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:347](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L347)
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• **customer\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:343](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L343)
|
||||
|
||||
___
|
||||
|
||||
### 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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### discount\_total
|
||||
|
||||
• `Optional` **discount\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:397](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L397)
|
||||
|
||||
___
|
||||
|
||||
### discounts
|
||||
|
||||
• **discounts**: [`Discount`](Discount.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:325](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L325)
|
||||
|
||||
___
|
||||
|
||||
### email
|
||||
|
||||
• **email**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:278](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L278)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_tax\_total
|
||||
|
||||
• `Optional` **gift\_card\_tax\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:407](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L407)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_total
|
||||
|
||||
• `Optional` **gift\_card\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:406](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L406)
|
||||
|
||||
___
|
||||
|
||||
### gift\_cards
|
||||
|
||||
• **gift\_cards**: [`GiftCard`](GiftCard.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:339](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L339)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### idempotency\_key
|
||||
|
||||
• **idempotency\_key**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:379](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L379)
|
||||
|
||||
___
|
||||
|
||||
### item\_tax\_total
|
||||
|
||||
• `Optional` **item\_tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:399](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L399)
|
||||
|
||||
___
|
||||
|
||||
### items
|
||||
|
||||
• **items**: [`LineItem`](LineItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:303](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L303)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:385](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L385)
|
||||
|
||||
___
|
||||
|
||||
### object
|
||||
|
||||
• `Readonly` **object**: ``"cart"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:275](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L275)
|
||||
|
||||
___
|
||||
|
||||
### payment
|
||||
|
||||
• **payment**: [`Payment`](Payment.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:362](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L362)
|
||||
|
||||
___
|
||||
|
||||
### payment\_authorized\_at
|
||||
|
||||
• **payment\_authorized\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:376](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L376)
|
||||
|
||||
___
|
||||
|
||||
### payment\_id
|
||||
|
||||
• **payment\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:358](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L358)
|
||||
|
||||
___
|
||||
|
||||
### payment\_session
|
||||
|
||||
• **payment\_session**: ``null`` \| [`PaymentSession`](PaymentSession.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:349](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L349)
|
||||
|
||||
___
|
||||
|
||||
### payment\_sessions
|
||||
|
||||
• **payment\_sessions**: [`PaymentSession`](PaymentSession.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:354](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L354)
|
||||
|
||||
___
|
||||
|
||||
### raw\_discount\_total
|
||||
|
||||
• `Optional` **raw\_discount\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:398](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L398)
|
||||
|
||||
___
|
||||
|
||||
### refundable\_amount
|
||||
|
||||
• `Optional` **refundable\_amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:405](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L405)
|
||||
|
||||
___
|
||||
|
||||
### refunded\_total
|
||||
|
||||
• `Optional` **refunded\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:402](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L402)
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• **region**: [`Region`](Region.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:311](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L311)
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• **region\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:307](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L307)
|
||||
|
||||
___
|
||||
|
||||
### sales\_channel
|
||||
|
||||
• **sales\_channel**: [`SalesChannel`](SalesChannel.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:394](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L394)
|
||||
|
||||
___
|
||||
|
||||
### sales\_channel\_id
|
||||
|
||||
• **sales\_channel\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:388](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L388)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address
|
||||
|
||||
• **shipping\_address**: ``null`` \| [`Address`](Address.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:298](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L298)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address\_id
|
||||
|
||||
• **shipping\_address\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:292](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L292)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_methods
|
||||
|
||||
• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:367](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L367)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_tax\_total
|
||||
|
||||
• `Optional` **shipping\_tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:400](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L400)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_total
|
||||
|
||||
• `Optional` **shipping\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:396](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L396)
|
||||
|
||||
___
|
||||
|
||||
### subtotal
|
||||
|
||||
• `Optional` **subtotal**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:404](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L404)
|
||||
|
||||
___
|
||||
|
||||
### tax\_total
|
||||
|
||||
• `Optional` **tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:401](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L401)
|
||||
|
||||
___
|
||||
|
||||
### total
|
||||
|
||||
• `Optional` **total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:403](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L403)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`CartType`](../enums/CartType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:370](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L370)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### afterLoad
|
||||
|
||||
▸ `Private` **afterLoad**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:410](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L410)
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/cart.ts:417](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L417)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,131 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ClaimImage
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`ClaimImage`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ClaimImage**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### claim\_item
|
||||
|
||||
• **claim\_item**: [`ClaimItem`](ClaimItem.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### claim\_item\_id
|
||||
|
||||
• **claim\_item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### url
|
||||
|
||||
• **url**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L26)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-image.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L32)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,211 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ClaimItem
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`ClaimItem`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ClaimItem**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### claim\_order
|
||||
|
||||
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order\_id
|
||||
|
||||
• **claim\_order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### images
|
||||
|
||||
• **images**: [`ClaimImage`](ClaimImage.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
### item
|
||||
|
||||
• **item**: [`LineItem`](LineItem.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### item\_id
|
||||
|
||||
• **item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
### note
|
||||
|
||||
• **note**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
### reason
|
||||
|
||||
• **reason**: [`ClaimReason`](../enums/ClaimReason.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
### tags
|
||||
|
||||
• **tags**: [`ClaimTag`](ClaimTag.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### variant
|
||||
|
||||
• **variant**: [`ProductVariant`](ProductVariant.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
### variant\_id
|
||||
|
||||
• **variant\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L54)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-item.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L87)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,261 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ClaimOrder
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`ClaimOrder`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ClaimOrder**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### additional\_items
|
||||
|
||||
• **additional\_items**: [`LineItem`](LineItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• **canceled\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
### claim\_items
|
||||
|
||||
• **claim\_items**: [`ClaimItem`](ClaimItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Overrides
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L110)
|
||||
|
||||
___
|
||||
|
||||
### deleted\_at
|
||||
|
||||
• **deleted\_at**: `Date`
|
||||
|
||||
#### Overrides
|
||||
|
||||
SoftDeletableEntity.deleted\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
### fulfillment\_status
|
||||
|
||||
• **fulfillment\_status**: [`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
### fulfillments
|
||||
|
||||
• **fulfillments**: [`Fulfillment`](Fulfillment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### idempotency\_key
|
||||
|
||||
• **idempotency\_key**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L125)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L122)
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L119)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
### payment\_status
|
||||
|
||||
• **payment\_status**: [`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### refund\_amount
|
||||
|
||||
• **refund\_amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L104)
|
||||
|
||||
___
|
||||
|
||||
### return\_order
|
||||
|
||||
• **return\_order**: [`Return`](Return.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L83)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address
|
||||
|
||||
• **shipping\_address**: [`Address`](Address.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L91)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address\_id
|
||||
|
||||
• **shipping\_address\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_methods
|
||||
|
||||
• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L96)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`ClaimType`](../enums/ClaimType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Overrides
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L113)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-order.ts:128](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L128)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,111 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ClaimTag
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`ClaimTag`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ClaimTag**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-tag.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-tag.ts#L11)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/claim-tag.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-tag.ts#L17)
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# ClaimTag
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,91 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Country
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Country**()
|
||||
|
||||
## Properties
|
||||
|
||||
### display\_name
|
||||
|
||||
• **display\_name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/country.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/country.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
### iso\_2
|
||||
|
||||
• **iso\_2**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/country.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### iso\_3
|
||||
|
||||
• **iso\_3**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/country.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/country.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### num\_code
|
||||
|
||||
• **num\_code**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/country.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• **region**: [`Region`](Region.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/country.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• **region\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/country.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L35)
|
||||
@@ -0,0 +1,442 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Country
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "display_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "iso_2",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "iso_3",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "num_code",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[`Region`](Region.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "constructor",
|
||||
"type": "() => [`Region`](Region.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "automatic_taxes",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "countries",
|
||||
"type": "[`Country`](Country.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "constructor",
|
||||
"type": "() => [`Country`](Country.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "display_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "iso_2",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "iso_3",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "num_code",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "region",
|
||||
"type": "[`Region`](Region.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "region_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "currency",
|
||||
"type": "[`Currency`](Currency.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "constructor",
|
||||
"type": "() => [`Currency`](Currency.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "includes_tax",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol_native",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "currency_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "fulfillment_providers",
|
||||
"type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "constructor",
|
||||
"type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_installed",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "gift_cards_taxable",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "includes_tax",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "payment_providers",
|
||||
"type": "[`PaymentProvider`](PaymentProvider.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "constructor",
|
||||
"type": "() => [`PaymentProvider`](PaymentProvider.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_installed",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "tax_code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "tax_provider",
|
||||
"type": "[`TaxProvider`](TaxProvider.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "constructor",
|
||||
"type": "() => [`TaxProvider`](TaxProvider.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_installed",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "tax_provider_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "tax_rate",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "tax_rates",
|
||||
"type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "beforeInsert",
|
||||
"type": "() => `void`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "region_id",
|
||||
"type": "``null`` \\| `string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,61 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Currency
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Currency**()
|
||||
|
||||
## Properties
|
||||
|
||||
### code
|
||||
|
||||
• **code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/currency.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L8)
|
||||
|
||||
___
|
||||
|
||||
### includes\_tax
|
||||
|
||||
• `Optional` **includes\_tax**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/currency.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/currency.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### symbol
|
||||
|
||||
• **symbol**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/currency.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
### symbol\_native
|
||||
|
||||
• **symbol\_native**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/currency.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L14)
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Currency
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "code",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "includes_tax",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "symbol_native",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,151 +0,0 @@
|
||||
---
|
||||
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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/custom-shipping-option.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/custom-shipping-option.ts#L43)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,211 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Customer
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`Customer`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Customer**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### billing\_address
|
||||
|
||||
• **billing\_address**: [`Address`](Address.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### billing\_address\_id
|
||||
|
||||
• **billing\_address\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### email
|
||||
|
||||
• **email**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### first\_name
|
||||
|
||||
• **first\_name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### groups
|
||||
|
||||
• **groups**: [`CustomerGroup`](CustomerGroup.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:71](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
### has\_account
|
||||
|
||||
• **has\_account**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### last\_name
|
||||
|
||||
• **last\_name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:74](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
### orders
|
||||
|
||||
• **orders**: [`Order`](Order.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### password\_hash
|
||||
|
||||
• **password\_hash**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### phone
|
||||
|
||||
• **phone**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_addresses
|
||||
|
||||
• **shipping\_addresses**: [`Address`](Address.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L77)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,131 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: CustomerGroup
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`CustomerGroup`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new CustomerGroup**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### customers
|
||||
|
||||
• **customers**: [`Customer`](Customer.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L18)
|
||||
|
||||
___
|
||||
|
||||
### 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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### price\_lists
|
||||
|
||||
• **price\_lists**: [`PriceList`](PriceList.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/customer-group.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L29)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,231 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Discount
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`Discount`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Discount**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### code
|
||||
|
||||
• **code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### ends\_at
|
||||
|
||||
• **ends\_at**: ``null`` \| `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### is\_disabled
|
||||
|
||||
• **is\_disabled**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### is\_dynamic
|
||||
|
||||
• **is\_dynamic**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:78](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
### parent\_discount
|
||||
|
||||
• **parent\_discount**: [`Discount`](Discount.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
### parent\_discount\_id
|
||||
|
||||
• **parent\_discount\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### regions
|
||||
|
||||
• **regions**: [`Region`](Region.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### rule
|
||||
|
||||
• **rule**: [`DiscountRule`](DiscountRule.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### rule\_id
|
||||
|
||||
• **rule\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### starts\_at
|
||||
|
||||
• **starts\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### usage\_count
|
||||
|
||||
• **usage\_count**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
### usage\_limit
|
||||
|
||||
• **usage\_limit**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
### valid\_duration
|
||||
|
||||
• **valid\_duration**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L55)
|
||||
|
||||
## Methods
|
||||
|
||||
### upperCaseCodeAndTrim
|
||||
|
||||
▸ `Private` **upperCaseCodeAndTrim**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L81)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,191 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: DiscountCondition
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`DiscountCondition`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DiscountCondition**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### customer\_groups
|
||||
|
||||
• **customer\_groups**: [`CustomerGroup`](CustomerGroup.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:129](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L129)
|
||||
|
||||
___
|
||||
|
||||
### 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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### discount\_rule
|
||||
|
||||
• **discount\_rule**: [`DiscountRule`](DiscountRule.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### discount\_rule\_id
|
||||
|
||||
• **discount\_rule\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L132)
|
||||
|
||||
___
|
||||
|
||||
### operator
|
||||
|
||||
• **operator**: [`DiscountConditionOperator`](../enums/DiscountConditionOperator.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### product\_collections
|
||||
|
||||
• **product\_collections**: [`ProductCollection`](ProductCollection.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:115](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L115)
|
||||
|
||||
___
|
||||
|
||||
### product\_tags
|
||||
|
||||
• **product\_tags**: [`ProductTag`](ProductTag.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:101](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
### product\_types
|
||||
|
||||
• **product\_types**: [`ProductType`](ProductType.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
### products
|
||||
|
||||
• **products**: [`Product`](Product.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`DiscountConditionType`](../enums/DiscountConditionType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition.ts:135](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L135)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,81 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: DiscountConditionCustomerGroup
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DiscountConditionCustomerGroup**()
|
||||
|
||||
## Properties
|
||||
|
||||
### condition\_id
|
||||
|
||||
• **condition\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### customer\_group
|
||||
|
||||
• `Optional` **customer\_group**: [`CustomerGroup`](CustomerGroup.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### customer\_group\_id
|
||||
|
||||
• **customer\_group\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### discount\_condition
|
||||
|
||||
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L34)
|
||||
+1304
File diff suppressed because it is too large.
Load diff
@@ -1,81 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: DiscountConditionProduct
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DiscountConditionProduct**()
|
||||
|
||||
## Properties
|
||||
|
||||
### condition\_id
|
||||
|
||||
• **condition\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### discount\_condition
|
||||
|
||||
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### product
|
||||
|
||||
• `Optional` **product**: [`Product`](Product.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### product\_id
|
||||
|
||||
• **product\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L34)
|
||||
File diff suppressed because it is too large.
Load diff
-81
@@ -1,81 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: DiscountConditionProductCollection
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DiscountConditionProductCollection**()
|
||||
|
||||
## Properties
|
||||
|
||||
### condition\_id
|
||||
|
||||
• **condition\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### discount\_condition
|
||||
|
||||
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### product\_collection
|
||||
|
||||
• `Optional` **product\_collection**: [`ProductCollection`](ProductCollection.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### product\_collection\_id
|
||||
|
||||
• **product\_collection\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L34)
|
||||
+1351
File diff suppressed because it is too large.
Load diff
@@ -1,81 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: DiscountConditionProductTag
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DiscountConditionProductTag**()
|
||||
|
||||
## Properties
|
||||
|
||||
### condition\_id
|
||||
|
||||
• **condition\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### discount\_condition
|
||||
|
||||
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### product\_tag
|
||||
|
||||
• `Optional` **product\_tag**: [`ProductTag`](ProductTag.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### product\_tag\_id
|
||||
|
||||
• **product\_tag\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L34)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,81 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: DiscountConditionProductType
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DiscountConditionProductType**()
|
||||
|
||||
## Properties
|
||||
|
||||
### condition\_id
|
||||
|
||||
• **condition\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### discount\_condition
|
||||
|
||||
• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### product\_type
|
||||
|
||||
• `Optional` **product\_type**: [`ProductType`](ProductType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### product\_type\_id
|
||||
|
||||
• **product\_type\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L34)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,151 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: DiscountRule
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`DiscountRule`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DiscountRule**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### allocation
|
||||
|
||||
• **allocation**: [`AllocationType`](../enums/AllocationType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### conditions
|
||||
|
||||
• **conditions**: [`DiscountCondition`](DiscountCondition.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`DiscountRuleType`](../enums/DiscountRuleType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L31)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/discount-rule.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L47)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,187 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: DraftOrder
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`DraftOrder`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new DraftOrder**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• **canceled\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### completed\_at
|
||||
|
||||
• **completed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### display\_id
|
||||
|
||||
• **display\_id**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### idempotency\_key
|
||||
|
||||
• **idempotency\_key**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
### no\_notification\_order
|
||||
|
||||
• **no\_notification\_order**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: [`DraftOrderStatus`](../enums/DraftOrderStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `Promise`<`void`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L68)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,257 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Fulfillment
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`Fulfillment`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Fulfillment**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• **canceled\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order
|
||||
|
||||
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order\_id
|
||||
|
||||
• **claim\_order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### idempotency\_key
|
||||
|
||||
• **idempotency\_key**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:88](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
### items
|
||||
|
||||
• **items**: [`FulfillmentItem`](FulfillmentItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### location\_id
|
||||
|
||||
• **location\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### provider
|
||||
|
||||
• **provider**: [`FulfillmentProvider`](FulfillmentProvider.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### provider\_id
|
||||
|
||||
• **provider\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### shipped\_at
|
||||
|
||||
• **shipped\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
### swap
|
||||
|
||||
• **swap**: [`Swap`](Swap.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### swap\_id
|
||||
|
||||
• **swap\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### tracking\_links
|
||||
|
||||
• **tracking\_links**: [`TrackingLink`](TrackingLink.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
### tracking\_numbers
|
||||
|
||||
• **tracking\_numbers**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L91)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,61 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: FulfillmentItem
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new FulfillmentItem**()
|
||||
|
||||
## Properties
|
||||
|
||||
### fulfillment
|
||||
|
||||
• **fulfillment**: [`Fulfillment`](Fulfillment.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### fulfillment\_id
|
||||
|
||||
• **fulfillment\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
### item
|
||||
|
||||
• **item**: [`LineItem`](LineItem.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### item\_id
|
||||
|
||||
• **item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L23)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,31 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: FulfillmentProvider
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new FulfillmentProvider**()
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-provider.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
### is\_installed
|
||||
|
||||
• **is\_installed**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-provider.ts#L9)
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# FulfillmentProvider
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_installed",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,201 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: GiftCard
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`GiftCard`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new GiftCard**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### balance
|
||||
|
||||
• **balance**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### code
|
||||
|
||||
• **code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### ends\_at
|
||||
|
||||
• **ends\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### is\_disabled
|
||||
|
||||
• **is\_disabled**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• **region**: [`Region`](Region.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• **region\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
### tax\_rate
|
||||
|
||||
• **tax\_rate**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L23)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card.ts:60](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L60)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,115 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: GiftCardTransaction
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new GiftCardTransaction**()
|
||||
|
||||
## Properties
|
||||
|
||||
### amount
|
||||
|
||||
• **amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card
|
||||
|
||||
• **gift\_card**: [`GiftCard`](GiftCard.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_id
|
||||
|
||||
• **gift\_card\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### is\_taxable
|
||||
|
||||
• **is\_taxable**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### tax\_rate
|
||||
|
||||
• **tax\_rate**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L49)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/gift-card-transaction.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L52)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,125 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: IdempotencyKey
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new IdempotencyKey**()
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### idempotency\_key
|
||||
|
||||
• **idempotency\_key**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### locked\_at
|
||||
|
||||
• **locked\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### recovery\_point
|
||||
|
||||
• **recovery\_point**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
### request\_method
|
||||
|
||||
• **request\_method**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### request\_params
|
||||
|
||||
• **request\_params**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### request\_path
|
||||
|
||||
• **request\_path**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
### response\_body
|
||||
|
||||
• **response\_body**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### response\_code
|
||||
|
||||
• **response\_code**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L38)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/idempotency-key.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L47)
|
||||
@@ -0,0 +1,92 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# IdempotencyKey
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "idempotency_key",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "locked_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "recovery_point",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "request_method",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "request_params",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "request_path",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "response_body",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "response_code",
|
||||
"type": "`number`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,111 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Image
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`Image`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Image**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/image.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/image.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### url
|
||||
|
||||
• **url**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/image.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/image.ts#L10)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/image.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/image.ts#L16)
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Image
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "url",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,151 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Invite
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`Invite`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Invite**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### accepted
|
||||
|
||||
• **accepted**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/invite.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### expires\_at
|
||||
|
||||
• **expires\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/invite.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/invite.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### role
|
||||
|
||||
• **role**: [`UserRoles`](../enums/UserRoles.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/invite.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### token
|
||||
|
||||
• **token**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/invite.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### user\_email
|
||||
|
||||
• **user\_email**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/invite.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L12)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/invite.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L35)
|
||||
@@ -0,0 +1,117 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Invite
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "accepted",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "expires_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "role",
|
||||
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "ADMIN",
|
||||
"type": "``\"admin\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "DEVELOPER",
|
||||
"type": "``\"developer\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "MEMBER",
|
||||
"type": "``\"member\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "token",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "user_email",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,505 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: LineItem
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`LineItem`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new LineItem**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### adjustments
|
||||
|
||||
• **adjustments**: [`LineItemAdjustment`](LineItemAdjustment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
### allow\_discounts
|
||||
|
||||
• **allow\_discounts**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:118](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L118)
|
||||
|
||||
___
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order
|
||||
|
||||
• **claim\_order**: [`ClaimOrder`](ClaimOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
### claim\_order\_id
|
||||
|
||||
• **claim\_order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:103](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L103)
|
||||
|
||||
___
|
||||
|
||||
### discount\_total
|
||||
|
||||
• `Optional` **discount\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:161](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L161)
|
||||
|
||||
___
|
||||
|
||||
### fulfilled\_quantity
|
||||
|
||||
• **fulfilled\_quantity**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:141](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L141)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_total
|
||||
|
||||
• `Optional` **gift\_card\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:163](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L163)
|
||||
|
||||
___
|
||||
|
||||
### has\_shipping
|
||||
|
||||
• **has\_shipping**: ``null`` \| `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:121](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### includes\_tax
|
||||
|
||||
• **includes\_tax**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:153](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
### is\_giftcard
|
||||
|
||||
• **is\_giftcard**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:112](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L112)
|
||||
|
||||
___
|
||||
|
||||
### is\_return
|
||||
|
||||
• **is\_return**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:109](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L109)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:150](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L150)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
### order\_edit
|
||||
|
||||
• `Optional` **order\_edit**: ``null`` \| [`OrderEdit`](OrderEdit.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
### order\_edit\_id
|
||||
|
||||
• `Optional` **order\_edit\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:93](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L93)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
### original\_item\_id
|
||||
|
||||
• `Optional` **original\_item\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
### original\_tax\_total
|
||||
|
||||
• `Optional` **original\_tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:160](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L160)
|
||||
|
||||
___
|
||||
|
||||
### original\_total
|
||||
|
||||
• `Optional` **original\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:159](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L159)
|
||||
|
||||
___
|
||||
|
||||
### product\_id
|
||||
|
||||
• **product\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:135](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L135)
|
||||
|
||||
___
|
||||
|
||||
### quantity
|
||||
|
||||
• **quantity**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:138](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L138)
|
||||
|
||||
___
|
||||
|
||||
### raw\_discount\_total
|
||||
|
||||
• `Optional` **raw\_discount\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:162](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L162)
|
||||
|
||||
___
|
||||
|
||||
### refundable
|
||||
|
||||
• `Optional` **refundable**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:155](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L155)
|
||||
|
||||
___
|
||||
|
||||
### returned\_quantity
|
||||
|
||||
• **returned\_quantity**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:144](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L144)
|
||||
|
||||
___
|
||||
|
||||
### shipped\_quantity
|
||||
|
||||
• **shipped\_quantity**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:147](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L147)
|
||||
|
||||
___
|
||||
|
||||
### should\_merge
|
||||
|
||||
• **should\_merge**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:115](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L115)
|
||||
|
||||
___
|
||||
|
||||
### subtotal
|
||||
|
||||
• `Optional` **subtotal**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:156](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L156)
|
||||
|
||||
___
|
||||
|
||||
### swap
|
||||
|
||||
• **swap**: [`Swap`](Swap.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### swap\_id
|
||||
|
||||
• **swap\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
### tax\_lines
|
||||
|
||||
• **tax\_lines**: [`LineItemTaxLine`](LineItemTaxLine.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:82](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
### tax\_total
|
||||
|
||||
• `Optional` **tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:157](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L157)
|
||||
|
||||
___
|
||||
|
||||
### thumbnail
|
||||
|
||||
• **thumbnail**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:106](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
### title
|
||||
|
||||
• **title**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:100](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
### total
|
||||
|
||||
• `Optional` **total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:158](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L158)
|
||||
|
||||
___
|
||||
|
||||
### unit\_price
|
||||
|
||||
• **unit\_price**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### variant
|
||||
|
||||
• **variant**: [`ProductVariant`](ProductVariant.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:132](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L132)
|
||||
|
||||
___
|
||||
|
||||
### variant\_id
|
||||
|
||||
• **variant\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L128)
|
||||
|
||||
## Methods
|
||||
|
||||
### afterUpdateOrLoad
|
||||
|
||||
▸ **afterUpdateOrLoad**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:193](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L193)
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:166](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L166)
|
||||
|
||||
___
|
||||
|
||||
### beforeUpdate
|
||||
|
||||
▸ **beforeUpdate**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item.ts:182](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L182)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,105 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: LineItemAdjustment
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new LineItemAdjustment**()
|
||||
|
||||
## Properties
|
||||
|
||||
### amount
|
||||
|
||||
• **amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### discount
|
||||
|
||||
• **discount**: [`Discount`](Discount.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### discount\_id
|
||||
|
||||
• **discount\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### item
|
||||
|
||||
• **item**: [`LineItem`](LineItem.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
### item\_id
|
||||
|
||||
• **item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L47)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L50)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,153 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: LineItemTaxLine
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `TaxLine`
|
||||
|
||||
↳ **`LineItemTaxLine`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new LineItemTaxLine**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TaxLine.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### code
|
||||
|
||||
• **code**: ``null`` \| `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TaxLine.code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TaxLine.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TaxLine.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### item
|
||||
|
||||
• **item**: [`LineItem`](LineItem.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-tax-line.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### item\_id
|
||||
|
||||
• **item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-tax-line.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TaxLine.metadata
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TaxLine.name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
### rate
|
||||
|
||||
• **rate**: `number`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TaxLine.rate
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TaxLine.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/line-item-tax-line.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-tax-line.ts#L27)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,239 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: MoneyAmount
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`MoneyAmount`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new MoneyAmount**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### amount
|
||||
|
||||
• **amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### currency
|
||||
|
||||
• `Optional` **currency**: [`Currency`](Currency.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### currency\_code
|
||||
|
||||
• **currency\_code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### 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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### max\_quantity
|
||||
|
||||
• **max\_quantity**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### min\_quantity
|
||||
|
||||
• **min\_quantity**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
### price\_list
|
||||
|
||||
• **price\_list**: ``null`` \| [`PriceList`](PriceList.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### price\_list\_id
|
||||
|
||||
• **price\_list\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• `Optional` **region**: [`Region`](Region.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• **region\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### variant
|
||||
|
||||
• **variant**: [`ProductVariant`](ProductVariant.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
### variant\_id
|
||||
|
||||
• **variant\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:68](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
### variants
|
||||
|
||||
• **variants**: [`ProductVariant`](ProductVariant.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L64)
|
||||
|
||||
## Methods
|
||||
|
||||
### afterLoad
|
||||
|
||||
▸ `Private` **afterLoad**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L99)
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `undefined` \| `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`undefined` \| `void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:79](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
### beforeUpdate
|
||||
|
||||
▸ `Private` **beforeUpdate**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/money-amount.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L90)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,151 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Note
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`Note`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Note**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### author
|
||||
|
||||
• **author**: [`User`](User.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/note.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### author\_id
|
||||
|
||||
• **author\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/note.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/note.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### resource\_id
|
||||
|
||||
• **resource\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/note.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### resource\_type
|
||||
|
||||
• **resource\_type**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/note.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/note.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L18)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/note.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L39)
|
||||
@@ -0,0 +1,222 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Note
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "author",
|
||||
"type": "[`User`](User.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "constructor",
|
||||
"type": "() => [`User`](User.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "api_token",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "email",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "first_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "last_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "password_hash",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "role",
|
||||
"type": "[`UserRoles`](../enums/UserRoles.mdx)",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": [
|
||||
{
|
||||
"name": "ADMIN",
|
||||
"type": "``\"admin\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "DEVELOPER",
|
||||
"type": "``\"developer\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "MEMBER",
|
||||
"type": "``\"member\"``",
|
||||
"description": "",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "beforeInsert",
|
||||
"type": "() => `void`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "author_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "created_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "deleted_at",
|
||||
"type": "``null`` \\| `Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "metadata",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "resource_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "resource_type",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "updated_at",
|
||||
"type": "`Date`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,197 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Notification
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`Notification`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Notification**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### customer
|
||||
|
||||
• **customer**: [`Customer`](Customer.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• **customer\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
### event\_name
|
||||
|
||||
• **event\_name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L20)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### parent\_id
|
||||
|
||||
• **parent\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### parent\_notification
|
||||
|
||||
• **parent\_notification**: [`Notification`](Notification.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### provider
|
||||
|
||||
• **provider**: `NotificationProvider`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### provider\_id
|
||||
|
||||
• **provider\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### resends
|
||||
|
||||
• **resends**: [`Notification`](Notification.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### resource\_id
|
||||
|
||||
• **resource\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### resource\_type
|
||||
|
||||
• **resource\_type**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L24)
|
||||
|
||||
___
|
||||
|
||||
### to
|
||||
|
||||
• **to**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/notification.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L62)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,85 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Oauth
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Oauth**()
|
||||
|
||||
## Properties
|
||||
|
||||
### application\_name
|
||||
|
||||
• **application\_name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/oauth.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/oauth.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### display\_name
|
||||
|
||||
• **display\_name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/oauth.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/oauth.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
### install\_url
|
||||
|
||||
• **install\_url**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/oauth.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### uninstall\_url
|
||||
|
||||
• **uninstall\_url**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/oauth.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L22)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/oauth.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L28)
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Oauth
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "application_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "data",
|
||||
"type": "Record<`string`, `unknown`\\>",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "display_name",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "install_url",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "uninstall_url",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,617 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Order
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`Order`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Order**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### billing\_address
|
||||
|
||||
• **billing\_address**: [`Address`](Address.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:117](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L117)
|
||||
|
||||
___
|
||||
|
||||
### billing\_address\_id
|
||||
|
||||
• **billing\_address\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:113](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• **canceled\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:218](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L218)
|
||||
|
||||
___
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:98](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L98)
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:94](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
### claims
|
||||
|
||||
• **claims**: [`ClaimOrder`](ClaimOrder.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:191](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L191)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### currency
|
||||
|
||||
• **currency**: [`Currency`](Currency.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:141](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L141)
|
||||
|
||||
___
|
||||
|
||||
### currency\_code
|
||||
|
||||
• **currency\_code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:137](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L137)
|
||||
|
||||
___
|
||||
|
||||
### customer
|
||||
|
||||
• **customer**: [`Customer`](Customer.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:106](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L106)
|
||||
|
||||
___
|
||||
|
||||
### customer\_id
|
||||
|
||||
• **customer\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:102](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L102)
|
||||
|
||||
___
|
||||
|
||||
### discount\_total
|
||||
|
||||
• **discount\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:244](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L244)
|
||||
|
||||
___
|
||||
|
||||
### discounts
|
||||
|
||||
• **discounts**: [`Discount`](Discount.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:158](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L158)
|
||||
|
||||
___
|
||||
|
||||
### display\_id
|
||||
|
||||
• **display\_id**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
### draft\_order
|
||||
|
||||
• **draft\_order**: [`DraftOrder`](DraftOrder.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:204](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L204)
|
||||
|
||||
___
|
||||
|
||||
### draft\_order\_id
|
||||
|
||||
• **draft\_order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:200](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L200)
|
||||
|
||||
___
|
||||
|
||||
### edits
|
||||
|
||||
• **edits**: [`OrderEdit`](OrderEdit.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:207](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L207)
|
||||
|
||||
___
|
||||
|
||||
### email
|
||||
|
||||
• **email**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:109](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L109)
|
||||
|
||||
___
|
||||
|
||||
### external\_id
|
||||
|
||||
• **external\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:230](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L230)
|
||||
|
||||
___
|
||||
|
||||
### fulfillment\_status
|
||||
|
||||
• **fulfillment\_status**: [`FulfillmentStatus`](../enums/FulfillmentStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:82](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
### fulfillments
|
||||
|
||||
• **fulfillments**: [`Fulfillment`](Fulfillment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:185](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L185)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_tax\_total
|
||||
|
||||
• **gift\_card\_tax\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:254](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L254)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_total
|
||||
|
||||
• **gift\_card\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:253](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L253)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_transactions
|
||||
|
||||
• **gift\_card\_transactions**: [`GiftCardTransaction`](GiftCardTransaction.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:215](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L215)
|
||||
|
||||
___
|
||||
|
||||
### gift\_cards
|
||||
|
||||
• **gift\_cards**: [`GiftCard`](GiftCard.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:172](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L172)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### idempotency\_key
|
||||
|
||||
• **idempotency\_key**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:227](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L227)
|
||||
|
||||
___
|
||||
|
||||
### item\_tax\_total
|
||||
|
||||
• **item\_tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:246](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L246)
|
||||
|
||||
___
|
||||
|
||||
### items
|
||||
|
||||
• **items**: [`LineItem`](LineItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:212](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L212)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:221](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L221)
|
||||
|
||||
___
|
||||
|
||||
### no\_notification
|
||||
|
||||
• **no\_notification**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:224](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L224)
|
||||
|
||||
___
|
||||
|
||||
### object
|
||||
|
||||
• `Readonly` **object**: ``"order"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
### paid\_total
|
||||
|
||||
• **paid\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:251](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L251)
|
||||
|
||||
___
|
||||
|
||||
### payment\_status
|
||||
|
||||
• **payment\_status**: [`PaymentStatus`](../enums/PaymentStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:85](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
### payments
|
||||
|
||||
• **payments**: [`Payment`](Payment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:180](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L180)
|
||||
|
||||
___
|
||||
|
||||
### raw\_discount\_total
|
||||
|
||||
• **raw\_discount\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:245](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L245)
|
||||
|
||||
___
|
||||
|
||||
### refundable\_amount
|
||||
|
||||
• **refundable\_amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:252](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L252)
|
||||
|
||||
___
|
||||
|
||||
### refunded\_total
|
||||
|
||||
• **refunded\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:248](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L248)
|
||||
|
||||
___
|
||||
|
||||
### refunds
|
||||
|
||||
• **refunds**: [`Refund`](Refund.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:194](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L194)
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• **region**: [`Region`](Region.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:133](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L133)
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• **region\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:129](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L129)
|
||||
|
||||
___
|
||||
|
||||
### returnable\_items
|
||||
|
||||
• `Optional` **returnable\_items**: [`LineItem`](LineItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:256](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L256)
|
||||
|
||||
___
|
||||
|
||||
### returns
|
||||
|
||||
• **returns**: [`Return`](Return.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:188](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L188)
|
||||
|
||||
___
|
||||
|
||||
### sales\_channel
|
||||
|
||||
• **sales\_channel**: [`SalesChannel`](SalesChannel.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:239](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L239)
|
||||
|
||||
___
|
||||
|
||||
### sales\_channel\_id
|
||||
|
||||
• **sales\_channel\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:233](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L233)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address
|
||||
|
||||
• **shipping\_address**: [`Address`](Address.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:125](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L125)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_address\_id
|
||||
|
||||
• **shipping\_address\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:121](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_methods
|
||||
|
||||
• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:177](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L177)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_tax\_total
|
||||
|
||||
• **shipping\_tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:243](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L243)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_total
|
||||
|
||||
• **shipping\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:242](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L242)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: [`OrderStatus`](../enums/OrderStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
### subtotal
|
||||
|
||||
• **subtotal**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:250](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L250)
|
||||
|
||||
___
|
||||
|
||||
### swaps
|
||||
|
||||
• **swaps**: [`Swap`](Swap.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:197](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L197)
|
||||
|
||||
___
|
||||
|
||||
### tax\_rate
|
||||
|
||||
• **tax\_rate**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:144](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L144)
|
||||
|
||||
___
|
||||
|
||||
### tax\_total
|
||||
|
||||
• **tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:247](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L247)
|
||||
|
||||
___
|
||||
|
||||
### total
|
||||
|
||||
• **total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:249](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L249)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `Promise`<`void`\>
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order.ts:259](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L259)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,351 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: OrderEdit
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`OrderEdit`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new OrderEdit**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• `Optional` **canceled\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
### canceled\_by
|
||||
|
||||
• `Optional` **canceled\_by**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
### changes
|
||||
|
||||
• **changes**: [`OrderItemChange`](OrderItemChange.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### confirmed\_at
|
||||
|
||||
• `Optional` **confirmed\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
### confirmed\_by
|
||||
|
||||
• `Optional` **confirmed\_by**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### created\_by
|
||||
|
||||
• **created\_by**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### declined\_at
|
||||
|
||||
• `Optional` **declined\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
### declined\_by
|
||||
|
||||
• `Optional` **declined\_by**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
### declined\_reason
|
||||
|
||||
• `Optional` **declined\_reason**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
### difference\_due
|
||||
|
||||
• **difference\_due**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L95)
|
||||
|
||||
___
|
||||
|
||||
### discount\_total
|
||||
|
||||
• **discount\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:88](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_tax\_total
|
||||
|
||||
• **gift\_card\_tax\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:93](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L93)
|
||||
|
||||
___
|
||||
|
||||
### gift\_card\_total
|
||||
|
||||
• **gift\_card\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:92](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L92)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### internal\_note
|
||||
|
||||
• `Optional` **internal\_note**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
### items
|
||||
|
||||
• **items**: [`LineItem`](LineItem.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### payment\_collection
|
||||
|
||||
• **payment\_collection**: [`PaymentCollection`](PaymentCollection.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
### payment\_collection\_id
|
||||
|
||||
• **payment\_collection\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:80](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
### requested\_at
|
||||
|
||||
• `Optional` **requested\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### requested\_by
|
||||
|
||||
• `Optional` **requested\_by**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### shipping\_total
|
||||
|
||||
• **shipping\_total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: [`OrderEditStatus`](../enums/OrderEditStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
### subtotal
|
||||
|
||||
• **subtotal**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L91)
|
||||
|
||||
___
|
||||
|
||||
### tax\_total
|
||||
|
||||
• **tax\_total**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:89](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L89)
|
||||
|
||||
___
|
||||
|
||||
### total
|
||||
|
||||
• **total**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L90)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:100](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
### loadStatus
|
||||
|
||||
▸ **loadStatus**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-edit.ts:105](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L105)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,161 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: OrderItemChange
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`OrderItemChange`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new OrderItemChange**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### line\_item
|
||||
|
||||
• `Optional` **line\_item**: [`LineItem`](LineItem.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-item-change.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### line\_item\_id
|
||||
|
||||
• `Optional` **line\_item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-item-change.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### order\_edit
|
||||
|
||||
• **order\_edit**: [`OrderEdit`](OrderEdit.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-item-change.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### order\_edit\_id
|
||||
|
||||
• **order\_edit\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-item-change.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
### original\_line\_item
|
||||
|
||||
• `Optional` **original\_line\_item**: [`LineItem`](LineItem.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-item-change.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### original\_line\_item\_id
|
||||
|
||||
• `Optional` **original\_line\_item\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-item-change.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`OrderEditItemChangeType`](../enums/OrderEditItemChangeType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-item-change.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/order-item-change.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L55)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,237 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Payment
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`Payment`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Payment**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### amount
|
||||
|
||||
• **amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### amount\_refunded
|
||||
|
||||
• **amount\_refunded**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
### canceled\_at
|
||||
|
||||
• **canceled\_at**: `string` \| `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
### captured\_at
|
||||
|
||||
• **captured\_at**: `string` \| `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### currency
|
||||
|
||||
• **currency**: [`Currency`](Currency.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### currency\_code
|
||||
|
||||
• **currency\_code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### idempotency\_key
|
||||
|
||||
• **idempotency\_key**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:78](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
### order
|
||||
|
||||
• **order**: [`Order`](Order.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### order\_id
|
||||
|
||||
• **order\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
### provider\_id
|
||||
|
||||
• **provider\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
### swap
|
||||
|
||||
• **swap**: [`Swap`](Swap.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### swap\_id
|
||||
|
||||
• **swap\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L84)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,221 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: PaymentCollection
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`PaymentCollection`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new PaymentCollection**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### amount
|
||||
|
||||
• **amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### authorized\_amount
|
||||
|
||||
• **authorized\_amount**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### created\_by
|
||||
|
||||
• **created\_by**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:94](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L94)
|
||||
|
||||
___
|
||||
|
||||
### currency
|
||||
|
||||
• **currency**: [`Currency`](Currency.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:60](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
### currency\_code
|
||||
|
||||
• **currency\_code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### 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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L91)
|
||||
|
||||
___
|
||||
|
||||
### payment\_sessions
|
||||
|
||||
• **payment\_sessions**: [`PaymentSession`](PaymentSession.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
### payments
|
||||
|
||||
• **payments**: [`Payment`](Payment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:88](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L88)
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• **region**: [`Region`](Region.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• **region\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: [`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`ORDER_EDIT`](../enums/PaymentCollectionType.md#order_edit)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-collection.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L97)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,31 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: PaymentProvider
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new PaymentProvider**()
|
||||
|
||||
## Properties
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-provider.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-provider.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
### is\_installed
|
||||
|
||||
• **is\_installed**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-provider.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-provider.ts#L9)
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# PaymentProvider
|
||||
|
||||
## Properties
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "is_installed",
|
||||
"type": "`boolean`",
|
||||
"description": "",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"children": []
|
||||
}
|
||||
]} />
|
||||
@@ -1,177 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: PaymentSession
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`PaymentSession`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new PaymentSession**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### amount
|
||||
|
||||
• **amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### cart
|
||||
|
||||
• **cart**: [`Cart`](Cart.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### cart\_id
|
||||
|
||||
• **cart\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### data
|
||||
|
||||
• **data**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### idempotency\_key
|
||||
|
||||
• **idempotency\_key**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### is\_initiated
|
||||
|
||||
• **is\_initiated**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
### is\_selected
|
||||
|
||||
• **is\_selected**: ``null`` \| `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
### payment\_authorized\_at
|
||||
|
||||
• **payment\_authorized\_at**: `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
### provider\_id
|
||||
|
||||
• **provider\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/payment-session.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L65)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,181 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: PriceList
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`PriceList`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new PriceList**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### customer\_groups
|
||||
|
||||
• **customer\_groups**: [`CustomerGroup`](CustomerGroup.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### 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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### ends\_at
|
||||
|
||||
• **ends\_at**: ``null`` \| `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### includes\_tax
|
||||
|
||||
• **includes\_tax**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### prices
|
||||
|
||||
• **prices**: [`MoneyAmount`](MoneyAmount.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
### starts\_at
|
||||
|
||||
• **starts\_at**: ``null`` \| `Date`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: `PriceListStatus`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: `PriceListType`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `undefined` \| `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`undefined` \| `void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/price-list.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L67)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,429 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: Product
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`Product`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new Product**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### categories
|
||||
|
||||
• **categories**: [`ProductCategory`](ProductCategory.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L95)
|
||||
|
||||
___
|
||||
|
||||
### collection
|
||||
|
||||
• **collection**: [`ProductCollection`](ProductCollection.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:146](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L146)
|
||||
|
||||
___
|
||||
|
||||
### collection\_id
|
||||
|
||||
• **collection\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:142](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L142)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### discountable
|
||||
|
||||
• **discountable**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:170](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L170)
|
||||
|
||||
___
|
||||
|
||||
### external\_id
|
||||
|
||||
• **external\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:173](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L173)
|
||||
|
||||
___
|
||||
|
||||
### handle
|
||||
|
||||
• **handle**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### height
|
||||
|
||||
• **height**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:124](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L124)
|
||||
|
||||
___
|
||||
|
||||
### hs\_code
|
||||
|
||||
• **hs\_code**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:130](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### images
|
||||
|
||||
• **images**: [`Image`](Image.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L70)
|
||||
|
||||
___
|
||||
|
||||
### is\_giftcard
|
||||
|
||||
• **is\_giftcard**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### length
|
||||
|
||||
• **length**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:121](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L121)
|
||||
|
||||
___
|
||||
|
||||
### material
|
||||
|
||||
• **material**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:139](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L139)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: ``null`` \| `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:176](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L176)
|
||||
|
||||
___
|
||||
|
||||
### mid\_code
|
||||
|
||||
• **mid\_code**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:136](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L136)
|
||||
|
||||
___
|
||||
|
||||
### options
|
||||
|
||||
• **options**: [`ProductOption`](ProductOption.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
### origin\_country
|
||||
|
||||
• **origin\_country**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:133](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L133)
|
||||
|
||||
___
|
||||
|
||||
### profile
|
||||
|
||||
• **profile**: [`ShippingProfile`](ShippingProfile.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L99)
|
||||
|
||||
___
|
||||
|
||||
### profile\_id
|
||||
|
||||
• **profile\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L97)
|
||||
|
||||
___
|
||||
|
||||
### profiles
|
||||
|
||||
• **profiles**: [`ShippingProfile`](ShippingProfile.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:115](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L115)
|
||||
|
||||
___
|
||||
|
||||
### sales\_channels
|
||||
|
||||
• **sales\_channels**: [`SalesChannel`](SalesChannel.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:192](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L192)
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: [`ProductStatus`](../enums/ProductStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### subtitle
|
||||
|
||||
• **subtitle**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L43)
|
||||
|
||||
___
|
||||
|
||||
### tags
|
||||
|
||||
• **tags**: [`ProductTag`](ProductTag.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:167](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
### thumbnail
|
||||
|
||||
• **thumbnail**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
### title
|
||||
|
||||
• **title**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`ProductType`](ProductType.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:153](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
### type\_id
|
||||
|
||||
• **type\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:149](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L149)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### variants
|
||||
|
||||
• **variants**: [`ProductVariant`](ProductVariant.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
### weight
|
||||
|
||||
• **weight**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:118](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L118)
|
||||
|
||||
___
|
||||
|
||||
### width
|
||||
|
||||
• **width**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:127](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L127)
|
||||
|
||||
## Methods
|
||||
|
||||
### afterLoad
|
||||
|
||||
▸ `Private` **afterLoad**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:215](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L215)
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:195](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L195)
|
||||
|
||||
___
|
||||
|
||||
### beforeUpdate
|
||||
|
||||
▸ `Private` **beforeUpdate**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product.ts:208](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L208)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,197 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ProductCategory
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `BaseEntity`
|
||||
|
||||
↳ **`ProductCategory`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ProductCategory**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### category\_children
|
||||
|
||||
• **category\_children**: [`ProductCategory`](ProductCategory.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L29)
|
||||
|
||||
___
|
||||
|
||||
### handle
|
||||
|
||||
• **handle**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### is\_active
|
||||
|
||||
• **is\_active**: `Boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### is\_internal
|
||||
|
||||
• **is\_internal**: `Boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### name
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### parent\_category
|
||||
|
||||
• **parent\_category**: ``null`` \| [`ProductCategory`](ProductCategory.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### parent\_category\_id
|
||||
|
||||
• **parent\_category\_id**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### products
|
||||
|
||||
• **products**: [`Product`](Product.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
### rank
|
||||
|
||||
• **rank**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
BaseEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### productCategoryProductJoinTable
|
||||
|
||||
▪ `Static` **productCategoryProductJoinTable**: `string` = `"product_category_product"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### treeRelations
|
||||
|
||||
▪ `Static` **treeRelations**: `string`[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L23)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-category.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L76)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,131 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ProductCollection
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`ProductCollection`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ProductCollection**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
||||
|
||||
___
|
||||
|
||||
### handle
|
||||
|
||||
• **handle**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-collection.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L16)
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.id
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-collection.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L22)
|
||||
|
||||
___
|
||||
|
||||
### products
|
||||
|
||||
• **products**: [`Product`](Product.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-collection.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### title
|
||||
|
||||
• **title**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-collection.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L12)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
## Methods
|
||||
|
||||
### createHandleIfNotProvided
|
||||
|
||||
▸ `Private` **createHandleIfNotProvided**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-collection.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L25)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,141 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ProductOption
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`ProductOption`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ProductOption**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
### product
|
||||
|
||||
• **product**: [`Product`](Product.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### product\_id
|
||||
|
||||
• **product\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
### title
|
||||
|
||||
• **title**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### values
|
||||
|
||||
• **values**: [`ProductOptionValue`](ProductOptionValue.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L24)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L37)
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1,151 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: entitiesSidebar
|
||||
---
|
||||
|
||||
# Class: ProductOptionValue
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `SoftDeletableEntity`
|
||||
|
||||
↳ **`ProductOptionValue`**
|
||||
|
||||
## Constructors
|
||||
|
||||
### constructor
|
||||
|
||||
• **new ProductOptionValue**()
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.constructor
|
||||
|
||||
## Properties
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.created\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/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/b38f73726/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/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option-value.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
### option
|
||||
|
||||
• **option**: [`ProductOption`](ProductOption.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option-value.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L27)
|
||||
|
||||
___
|
||||
|
||||
### option\_id
|
||||
|
||||
• **option\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option-value.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: `Date`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
SoftDeletableEntity.updated\_at
|
||||
|
||||
#### Defined in
|
||||
|
||||
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### value
|
||||
|
||||
• **value**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option-value.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L19)
|
||||
|
||||
___
|
||||
|
||||
### variant
|
||||
|
||||
• **variant**: [`ProductVariant`](ProductVariant.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option-value.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
### variant\_id
|
||||
|
||||
• **variant\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option-value.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L31)
|
||||
|
||||
## Methods
|
||||
|
||||
### beforeInsert
|
||||
|
||||
▸ `Private` **beforeInsert**(): `void`
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[models/product-option-value.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L43)
|
||||
Loaded 100 of 540 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user