chore(docs): Updated API Reference (v2) (#9437)

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]
2024-10-03 07:48:54 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions
@@ -1,3 +1,61 @@
type: object
description: The payment session's payment sessions.
description: The payment session's details.
x-schemaName: BasePaymentSession
properties:
id:
type: string
title: id
description: The payment session's ID.
amount:
type: number
title: amount
description: The payment session's amount.
currency_code:
type: string
title: currency_code
description: The payment session's currency code.
example: usd
provider_id:
type: string
title: provider_id
description: The ID of the payment provider processing this session.
data:
type: object
description: >-
The payment session's data, useful for the payment provider processing the
payment.
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property
context:
type: object
description: The context around the payment, such as the customer's details.
example:
customer:
id: cus_123
status:
type: string
description: The payment session's status.
enum:
- authorized
- captured
- canceled
- pending
- requires_more
- error
authorized_at:
type: string
title: authorized_at
description: The date the payment session was authorized.
format: date-time
payment_collection:
type: object
payment:
$ref: ./BasePayment.yaml
required:
- id
- amount
- currency_code
- provider_id
- data
- status