chore(docs): Updated API Reference (#2903)
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
1f1b85afbb
commit
d93d337df7
@@ -137,6 +137,10 @@ paths:
|
||||
$ref: paths/auth.yaml
|
||||
/auth/{email}:
|
||||
$ref: paths/auth_{email}.yaml
|
||||
/collections/{id}:
|
||||
$ref: paths/collections_{id}.yaml
|
||||
/collections:
|
||||
$ref: paths/collections.yaml
|
||||
/carts/{id}/shipping-methods:
|
||||
$ref: paths/carts_{id}_shipping-methods.yaml
|
||||
/carts/{id}/taxes:
|
||||
@@ -159,10 +163,6 @@ paths:
|
||||
$ref: paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
|
||||
/carts/{id}/payment-session:
|
||||
$ref: paths/carts_{id}_payment-session.yaml
|
||||
/collections/{id}:
|
||||
$ref: paths/collections_{id}.yaml
|
||||
/collections:
|
||||
$ref: paths/collections.yaml
|
||||
/customers/me/addresses:
|
||||
$ref: paths/customers_me_addresses.yaml
|
||||
/customers:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: PostOrdersCustomerOrderClaim
|
||||
summary: Claim orders for signed in account
|
||||
summary: Claim an Order
|
||||
description: >-
|
||||
Sends an email to emails registered to orders provided with link to transfer
|
||||
order ownership
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept
|
||||
summary: Verify a claim to orders
|
||||
summary: Verify an Order Claim
|
||||
description: >-
|
||||
Verifies the claim order token provided to the customer upon request of
|
||||
order ownership
|
||||
@@ -22,7 +22,7 @@ post:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Invite
|
||||
- Order
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
get:
|
||||
operationId: GetPaymentCollectionsPaymentCollection
|
||||
summary: Retrieve an PaymentCollection
|
||||
description: Retrieves a PaymentCollection.
|
||||
summary: Get a PaymentCollection
|
||||
description: Get a Payment Collection
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- in: path
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: PostPaymentCollectionsSessions
|
||||
summary: Manage Payment Sessions from Payment Collections
|
||||
summary: Manage a Payment Session
|
||||
description: Manages Payment Sessions from Payment Collections.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
@@ -29,7 +29,7 @@ post:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Payment
|
||||
- PaymentCollection
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: PostPaymentCollectionsPaymentCollectionSessionsBatch
|
||||
summary: Manage Multiple Payment Sessions from Payment Collections
|
||||
summary: Manage Payment Sessions
|
||||
description: Manages Multiple Payment Sessions from Payment Collections.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
@@ -31,7 +31,7 @@ post:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Payment
|
||||
- PaymentCollection
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: PostPaymentCollectionsSessionsBatchAuthorize
|
||||
summary: Authorize Payment Sessions of a Payment Collection
|
||||
summary: Authorize PaymentSessions
|
||||
description: Authorizes Payment Sessions of a Payment Collection.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
@@ -31,7 +31,7 @@ post:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Payment
|
||||
- PaymentCollection
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: PostPaymentCollectionsSessionsSessionAuthorize
|
||||
summary: Authorize a Payment Session of a Payment Collection
|
||||
summary: Authorize Payment Session
|
||||
description: Authorizes a Payment Session of a Payment Collection.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
@@ -31,7 +31,7 @@ post:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
tags:
|
||||
- Payment
|
||||
- PaymentCollection
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
|
||||
Reference in New Issue
Block a user