chore(docs): Generated API Reference (#5601)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and GitHub committed 2023-11-10 14:27:17 +02:00
1 parent 02e2ee4e8a
commit 01d4047976
496 files changed
+1456 -867

No files matched your search

@@ -91,6 +91,10 @@ delete:
x-codegen:
method: deleteSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_auth/delete.js
- lang: Shell
label: cURL
source:
@@ -10,8 +10,8 @@ post:
changes their region.
If a customer is logged in, the cart's customer ID and email will
automatically be set.
If a customer is logged in, make sure to pass its ID or email within the
cart's details so that the cart is attached to the customer.
requestBody:
content:
application/json:
@@ -2,8 +2,8 @@ post:
summary: Complete a Cart
operationId: PostCartsCartComplete
description: >
Complete a cart and place an order or create a swap, based on what the cart
is created for. This includes attempting to authorize the cart's payment.
Complete a cart and place an order or create a swap, based on the cart's
type. This includes attempting to authorize the cart's payment.
If authorizing the payment requires more action, the cart will not be
completed and the order will not be placed or the swap will not be created.
@@ -3,8 +3,8 @@ delete:
summary: Remove Discount
description: >-
Remove a Discount from a Cart. This only removes the application of the
discount, and not completely delete it. The totals will be re-calculated and
the payment sessions will be refreshed after the removal.
discount, and not completely deletes it. The totals will be re-calculated
and the payment sessions will be refreshed after the removal.
parameters:
- in: path
name: id
@@ -3,7 +3,7 @@ post:
summary: Create Payment Sessions
description: >-
Create Payment Sessions for each of the available Payment Providers in the
Cart's Region. If there only one payment session is created, it will be
Cart's Region. If there's only one payment session created, it will be
selected by default. The creation of the payment session uses the payment
provider and may require sending requests to third-party services.
parameters:
@@ -10,7 +10,7 @@ post:
- in: path
name: id
required: true
description: The ID of the Payment Collections.
description: The ID of the Payment Collection.
schema:
type: string
requestBody:
@@ -7,7 +7,7 @@ post:
- in: path
name: id
required: true
description: The ID of the Payment Collections.
description: The ID of the Payment Collection.
schema:
type: string
- in: path
@@ -147,6 +147,10 @@ get:
method: list
queryParams: StoreGetVariantsParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_variants/get.js
- lang: Shell
label: cURL
source:
@@ -62,6 +62,10 @@ get:
method: retrieve
queryParams: StoreGetVariantsVariantParams
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/store_variants_{id}/get.js
- lang: Shell
label: cURL
source: