docs: added reference for JS Client (#1629)
* added reference for JS Client * added reference for JS Client * added reference for JS Client
This commit is contained in:
219
docs/content/references/js-client/classes/internal.Discount.md
Normal file
219
docs/content/references/js-client/classes/internal.Discount.md
Normal file
@@ -0,0 +1,219 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: Discount
|
||||
|
||||
[internal](../modules/internal.md).Discount
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md)
|
||||
|
||||
↳ **`Discount`**
|
||||
|
||||
## Properties
|
||||
|
||||
### code
|
||||
|
||||
• **code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### created\_at
|
||||
|
||||
• **created\_at**: [`Date`](../modules/internal.md#date)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### deleted\_at
|
||||
|
||||
• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
|
||||
|
||||
___
|
||||
|
||||
### ends\_at
|
||||
|
||||
• **ends\_at**: ``null`` \| [`Date`](../modules/internal.md#date)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### id
|
||||
|
||||
• **id**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### is\_disabled
|
||||
|
||||
• **is\_disabled**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### is\_dynamic
|
||||
|
||||
• **is\_dynamic**: `boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:18
|
||||
|
||||
___
|
||||
|
||||
### parent\_discount
|
||||
|
||||
• **parent\_discount**: [`Discount`](internal.Discount.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### parent\_discount\_id
|
||||
|
||||
• **parent\_discount\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### regions
|
||||
|
||||
• **regions**: [`Region`](internal.Region.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### rule
|
||||
|
||||
• **rule**: [`DiscountRule`](internal.DiscountRule.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### rule\_id
|
||||
|
||||
• **rule\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
### starts\_at
|
||||
|
||||
• **starts\_at**: [`Date`](../modules/internal.md#date)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### updated\_at
|
||||
|
||||
• **updated\_at**: [`Date`](../modules/internal.md#date)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/interfaces/models/base-entity.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
### upperCaseCode
|
||||
|
||||
• `Private` **upperCaseCode**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:19
|
||||
|
||||
___
|
||||
|
||||
### usage\_count
|
||||
|
||||
• **usage\_count**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### usage\_limit
|
||||
|
||||
• **usage\_limit**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:16
|
||||
|
||||
___
|
||||
|
||||
### valid\_duration
|
||||
|
||||
• **valid\_duration**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount.d.ts:14
|
||||
Reference in New Issue
Block a user