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:
committed by
GitHub
parent
378ca1b36e
commit
daea35fe73
@@ -0,0 +1,211 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: PaymentCollection
|
||||
|
||||
[internal](../modules/internal-3.md).PaymentCollection
|
||||
|
||||
Base abstract entity for all entities
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md)
|
||||
|
||||
↳ **`PaymentCollection`**
|
||||
|
||||
## Properties
|
||||
|
||||
### amount
|
||||
|
||||
• **amount**: `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### authorized\_amount
|
||||
|
||||
• **authorized\_amount**: ``null`` \| `number`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:18
|
||||
|
||||
___
|
||||
|
||||
### beforeInsert
|
||||
|
||||
• `Private` **beforeInsert**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:27
|
||||
|
||||
___
|
||||
|
||||
### 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
|
||||
|
||||
___
|
||||
|
||||
### created\_by
|
||||
|
||||
• **created\_by**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:26
|
||||
|
||||
___
|
||||
|
||||
### currency
|
||||
|
||||
• **currency**: [`Currency`](internal-3.Currency.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:22
|
||||
|
||||
___
|
||||
|
||||
### currency\_code
|
||||
|
||||
• **currency\_code**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
### 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
|
||||
|
||||
___
|
||||
|
||||
### description
|
||||
|
||||
• **description**: ``null`` \| `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:16
|
||||
|
||||
___
|
||||
|
||||
### 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
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:25
|
||||
|
||||
___
|
||||
|
||||
### payment\_sessions
|
||||
|
||||
• **payment\_sessions**: [`PaymentSession`](internal-3.PaymentSession.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:23
|
||||
|
||||
___
|
||||
|
||||
### payments
|
||||
|
||||
• **payments**: [`Payment`](internal-3.Payment.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:24
|
||||
|
||||
___
|
||||
|
||||
### region
|
||||
|
||||
• **region**: [`Region`](internal-3.Region.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:20
|
||||
|
||||
___
|
||||
|
||||
### region\_id
|
||||
|
||||
• **region\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:19
|
||||
|
||||
___
|
||||
|
||||
### status
|
||||
|
||||
• **status**: [`PaymentCollectionStatus`](../enums/internal-3.PaymentCollectionStatus.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### type
|
||||
|
||||
• **type**: [`ORDER_EDIT`](../modules/internal-3.md#order_edit)
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/payment-collection.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
### 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
|
||||
Reference in New Issue
Block a user