chore(docs): Generated JS Client Reference (#5334)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
@@ -0,0 +1,221 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: Discount
[internal](../modules/internal-3.md).Discount
Base abstract entity for all entities
## Hierarchy
- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md)
**`Discount`**
## Properties
### code
**code**: `string`
#### Defined in
packages/medusa/dist/models/discount.d.ts:5
___
### created\_at
**created\_at**: `Date`
#### Inherited from
[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at)
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:6
___
### deleted\_at
**deleted\_at**: ``null`` \| `Date`
#### Inherited from
[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at)
#### Defined in
packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
___
### ends\_at
• **ends\_at**: ``null`` \| `Date`
#### Defined in
packages/medusa/dist/models/discount.d.ts:13
___
### id
• **id**: `string`
#### Inherited from
[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.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-3.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-3.Region.md)[]
#### Defined in
packages/medusa/dist/models/discount.d.ts:15
___
### rule
• **rule**: [`DiscountRule`](internal-3.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`
#### Defined in
packages/medusa/dist/models/discount.d.ts:12
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at)
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:7
___
### upperCaseCodeAndTrim
• `Private` **upperCaseCodeAndTrim**: `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