chore(docs): Generated OAS (#6752)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andolivermrbl authored and GitHub committed 2024-03-20 11:30:24 +01:00
1 parent 95738804cd
commit 53653f5266
198 files changed
+8998 -331

No files matched your search

@@ -0,0 +1,44 @@
/**
* @oas [delete] /store/carts/{id}/line-items/{line_id}
* operationId: DeleteCartsIdLineItemsLine_id
* summary: Remove Line Items from Cart
* description: Remove a list of line items from a cart. This doesn't delete the
* Line Item, only the association between the Line Item and the cart.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* - name: line_id
* in: path
* description: The cart's line id.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X DELETE '{backend_url}/store/carts/{id}/line-items/{line_id}'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,38 @@
/**
* @oas [delete] /store/carts/{id}/promotions
* operationId: DeleteCartsIdPromotions
* summary: Remove Promotions from Cart
* description: Remove a list of promotions from a cart. This doesn't delete the
* Promotion, only the association between the Promotion and the cart.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X DELETE '{backend_url}/store/carts/{id}/promotions'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,38 @@
/**
* @oas [delete] /store/customers/me/addresses/{address_id}
* operationId: DeleteCustomersMeAddressesAddress_id
* summary: Remove Addresses from Customer
* description: Remove a list of addresses from a customer. This doesn't delete the
* Address, only the association between the Address and the customer.
* x-authenticated: false
* parameters:
* - name: address_id
* in: path
* description: The customer's address id.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,38 @@
/**
* @oas [get] /store/carts/{id}
* operationId: GetCartsId
* summary: Get a Cart
* description: Retrieve a cart by its ID. You can expand the cart's relations or
* select the fields that should be returned.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/carts/{id}'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,32 @@
/**
* @oas [get] /store/currencies
* operationId: GetCurrencies
* summary: List Currencies
* description: Retrieve a list of currencies. The currencies can be filtered by
* fields such as `id`. The currencies can also be sorted or paginated.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/currencies'
* tags:
* - Currencies
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,38 @@
/**
* @oas [get] /store/currencies/{code}
* operationId: GetCurrenciesCode
* summary: Get a Currency
* description: Retrieve a currency by its ID. You can expand the currency's
* relations or select the fields that should be returned.
* x-authenticated: false
* parameters:
* - name: code
* in: path
* description: The currency's code.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/currencies/{code}'
* tags:
* - Currencies
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,32 @@
/**
* @oas [get] /store/customers/me
* operationId: GetCustomersMe
* summary: List Customers
* description: Retrieve a list of customers. The customers can be filtered by
* fields such as `id`. The customers can also be sorted or paginated.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/customers/me'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,32 @@
/**
* @oas [get] /store/customers/me/addresses
* operationId: GetCustomersMeAddresses
* summary: List Customers
* description: Retrieve a list of customers. The customers can be filtered by
* fields such as `id`. The customers can also be sorted or paginated.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/customers/me/addresses'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,38 @@
/**
* @oas [get] /store/customers/me/addresses/{address_id}
* operationId: GetCustomersMeAddressesAddress_id
* summary: List Addresses
* description: Retrieve a list of addresses in a customer. The addresses can be
* filtered by fields like FILTER FIELDS. The addresses can also be paginated.
* x-authenticated: false
* parameters:
* - name: address_id
* in: path
* description: The customer's address id.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/customers/me/addresses/{address_id}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,32 @@
/**
* @oas [get] /store/regions
* operationId: GetRegions
* summary: List Regions
* description: Retrieve a list of regions. The regions can be filtered by fields
* such as `id`. The regions can also be sorted or paginated.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/regions'
* tags:
* - Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,38 @@
/**
* @oas [get] /store/regions/{id}
* operationId: GetRegionsId
* summary: Get a Region
* description: Retrieve a region by its ID. You can expand the region's relations
* or select the fields that should be returned.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The region's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/regions/{id}'
* tags:
* - Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,39 @@
/**
* @oas [get] /store/regions/{id}/payment-providers
* operationId: GetRegionsIdPaymentProviders
* summary: List Payment Providers
* description: Retrieve a list of payment providers in a region. The payment
* providers can be filtered by fields like FILTER FIELDS. The payment providers
* can also be paginated.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The region's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/regions/{id}/payment-providers'
* tags:
* - Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,38 @@
/**
* @oas [get] /store/shipping-options/{cart_id}
* operationId: GetShippingOptionsCart_id
* summary: Get a Shipping Option
* description: Retrieve a shipping option by its ID. You can expand the shipping
* option's relations or select the fields that should be returned.
* x-authenticated: false
* parameters:
* - name: cart_id
* in: path
* description: The shipping option's cart id.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/shipping-options/{cart_id}'
* tags:
* - Shipping Options
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,31 @@
/**
* @oas [post] /store/carts
* operationId: PostCarts
* summary: Create Cart
* description: Create a cart.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,37 @@
/**
* @oas [post] /store/carts/{id}
* operationId: PostCartsId
* summary: Update a Cart
* description: Update a cart's details.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,37 @@
/**
* @oas [post] /store/carts/{id}/line-items
* operationId: PostCartsIdLineItems
* summary: Add Line Items to Cart
* description: Add a list of line items to a cart.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/line-items'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,43 @@
/**
* @oas [post] /store/carts/{id}/line-items/{line_id}
* operationId: PostCartsIdLineItemsLine_id
* summary: Add Line Items to Cart
* description: Add a list of line items to a cart.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* - name: line_id
* in: path
* description: The cart's line id.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,37 @@
/**
* @oas [post] /store/carts/{id}/payment-collections
* operationId: PostCartsIdPaymentCollections
* summary: Add Payment Collections to Cart
* description: Add a list of payment collections to a cart.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/payment-collections'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,37 @@
/**
* @oas [post] /store/carts/{id}/promotions
* operationId: PostCartsIdPromotions
* summary: Add Promotions to Cart
* description: Add a list of promotions to a cart.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/promotions'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,42 @@
/**
* @oas [post] /store/carts/{id}/taxes
* operationId: PostCartsIdTaxes
* summary: Add Taxes to Cart
* description: Add a list of taxes to a cart.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The cart's ID.
* required: true
* schema:
* type: string
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StorePostCartsCartTaxesReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/taxes'
* tags:
* - Carts
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,31 @@
/**
* @oas [post] /store/customers
* operationId: PostCustomers
* summary: Create Customer
* description: Create a customer.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/customers'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,31 @@
/**
* @oas [post] /store/customers/me/addresses
* operationId: PostCustomersMeAddresses
* summary: Create Customer
* description: Create a customer.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/customers/me/addresses'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,37 @@
/**
* @oas [post] /store/customers/me/addresses/{address_id}
* operationId: PostCustomersMeAddressesAddress_id
* summary: Add Addresses to Customer
* description: Add a list of addresses to a customer.
* x-authenticated: false
* parameters:
* - name: address_id
* in: path
* description: The customer's address id.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}'
* tags:
* - Customers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
@@ -0,0 +1,50 @@
/**
* @oas [post] /store/payment-collections/{id}/payment-sessions
* operationId: PostPaymentCollectionsIdPaymentSessions
* summary: Add Payment Sessions to Payment Collection
* description: Add a list of payment sessions to a payment collection.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The payment collection's ID.
* required: true
* schema:
* type: string
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StorePostPaymentCollectionsPaymentSessionReq"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X POST
* '{backend_url}/store/payment-collections/{id}/payment-sessions' \
*
* -H 'Content-Type: application/json' \
*
* --data-raw '{
* "provider_id": "{value}"
* }'
* tags:
* - Payment Collections
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/