chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -1,5 +1,8 @@
|
||||
title: Payment Collection
|
||||
description: Payment Collection
|
||||
description: >-
|
||||
A payment collection allows grouping and managing a list of payments at one.
|
||||
This can be helpful when making additional payment for order edits or
|
||||
integrating installment payments.
|
||||
type: object
|
||||
required:
|
||||
- amount
|
||||
@@ -46,32 +49,40 @@ properties:
|
||||
nullable: true
|
||||
type: integer
|
||||
region_id:
|
||||
description: The region's ID
|
||||
description: The ID of the region this payment collection is associated with.
|
||||
type: string
|
||||
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
||||
region:
|
||||
description: Available if the relation `region` is expanded.
|
||||
description: The details of the region this payment collection is associated with.
|
||||
x-expandable: region
|
||||
nullable: true
|
||||
$ref: ./Region.yaml
|
||||
currency_code:
|
||||
description: The 3 character ISO code for the currency.
|
||||
description: >-
|
||||
The 3 character ISO code for the currency this payment collection is
|
||||
associated with.
|
||||
type: string
|
||||
example: usd
|
||||
externalDocs:
|
||||
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
||||
description: See a list of codes.
|
||||
currency:
|
||||
description: Available if the relation `currency` is expanded.
|
||||
description: The details of the currency this payment collection is associated with.
|
||||
x-expandable: currency
|
||||
nullable: true
|
||||
$ref: ./Currency.yaml
|
||||
payment_sessions:
|
||||
description: Available if the relation `payment_sessions` is expanded.
|
||||
description: >-
|
||||
The details of the payment sessions created as part of the payment
|
||||
collection.
|
||||
type: array
|
||||
x-expandable: payment_sessions
|
||||
items:
|
||||
$ref: ./PaymentSession.yaml
|
||||
payments:
|
||||
description: Available if the relation `payments` is expanded.
|
||||
description: The details of the payments created as part of the payment collection.
|
||||
type: array
|
||||
x-expandable: payments
|
||||
items:
|
||||
$ref: ./Payment.yaml
|
||||
created_by:
|
||||
@@ -96,3 +107,7 @@ properties:
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
externalDocs:
|
||||
description: Learn about the metadata attribute, and how to delete and update it.
|
||||
url: >-
|
||||
https://docs.medusajs.com/development/entities/overview#metadata-attribute
|
||||
|
||||
Reference in New Issue
Block a user