asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: move docs-util to www (#7232)

Browse Source 
* reorganize docs apps

* add README

* fix directory

* add condition for old docs

* move docs-util to www

* remove remaining docs-util

* fixes of paths

* fix scripts

* path fixes

* fix github actions

* add build packages script
This commit is contained in:
Shahed Nasser
2024-05-06 09:13:50 +03:00
committed by GitHub
parent cf9605fe6f
commit b39de05535
607 changed files with 183 additions and 254 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts
+86
View File
@@ -0,0 +1,86 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X DELETE '{backend_url}/store/carts/{id}/line-items/{line_id}'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts
+91
View File
@@ -0,0 +1,91 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X DELETE '{backend_url}/store/carts/{id}/promotions'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - promo_codes
* properties:
* promo_codes:
* type: array
* description: The cart's promo codes.
* items:
* type: string
* title: promo_codes
* description: The promo code's promo codes.
*
*/
www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts
+80
View File
@@ -0,0 +1,80 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}'
* tags:
* - Customers
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts
+80
View File
@@ -0,0 +1,80 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/carts/{id}'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_collections.ts
+32
View File
@@ -0,0 +1,32 @@
/**
* @oas [get] /store/collections
* operationId: GetCollections
* summary: List Collections
* description: Retrieve a list of collections. The collections can be filtered by
* fields such as `id`. The collections can also be sorted or paginated.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/collections'
* tags:
* - 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"
*
*/
www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts
+78
View File
@@ -0,0 +1,78 @@
/**
* @oas [get] /store/collections/{id}
* operationId: GetCollectionsId
* summary: Get a Collection
* description: Retrieve a collection by its ID. You can expand the collection's
* relations or select the fields that should be returned.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The collection's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/collections/{id}'
* tags:
* - 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"
*
*/
www/utils/generated/oas-output/operations/store/get_store_currencies.ts
+74
View File
@@ -0,0 +1,74 @@
/**
* @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:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/currencies'
* tags:
* - Currencies
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts
+80
View File
@@ -0,0 +1,80 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/currencies/{code}'
* tags:
* - Currencies
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_customers_me.ts
+82
View File
@@ -0,0 +1,82 @@
/**
* @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:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/customers/me'
* tags:
* - Customers
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The customer's fields.
*
*/
www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts
+147
View File
@@ -0,0 +1,147 @@
/**
* @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:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/customers/me/addresses'
* tags:
* - Customers
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - metadata
* - first_name
* - last_name
* - phone
* - company
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - address_name
* - is_default_shipping
* - is_default_billing
* properties:
* metadata:
* type: object
* description: The customer's metadata.
* properties: {}
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* company:
* type: string
* title: company
* description: The customer's company.
* address_1:
* type: string
* title: address_1
* description: The customer's address 1.
* address_2:
* type: string
* title: address_2
* description: The customer's address 2.
* city:
* type: string
* title: city
* description: The customer's city.
* country_code:
* type: string
* title: country_code
* description: The customer's country code.
* province:
* type: string
* title: province
* description: The customer's province.
* postal_code:
* type: string
* title: postal_code
* description: The customer's postal code.
* address_name:
* type: string
* title: address_name
* description: The customer's address name.
* is_default_shipping:
* type: boolean
* title: is_default_shipping
* description: The customer's is default shipping.
* is_default_billing:
* type: boolean
* title: is_default_billing
* description: The customer's is default billing.
*
*/
www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts
+88
View File
@@ -0,0 +1,88 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/customers/me/addresses/{address_id}'
* tags:
* - Customers
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The customer's fields.
*
*/
www/utils/generated/oas-output/operations/store/get_store_product-categories.ts
+33
View File
@@ -0,0 +1,33 @@
/**
* @oas [get] /store/product-categories
* operationId: GetProductCategories
* summary: List Product Categories
* description: Retrieve a list of product categories. The product categories can
* be filtered by fields such as `id`. The product categories can also be sorted
* or paginated.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/product-categories'
* tags:
* - Product Categories
* 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"
*
*/
www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts
+68
View File
@@ -0,0 +1,68 @@
/**
* @oas [get] /store/product-categories/{id}
* operationId: GetProductCategoriesId
* summary: Get a Product Category
* description: Retrieve a product category by its ID. You can expand the product
* category's relations or select the fields that should be returned.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The product category's ID.
* required: true
* schema:
* type: string
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* - include_ancestors_tree
* - include_descendants_tree
* properties:
* fields:
* type: string
* title: fields
* description: The product category's fields.
* include_ancestors_tree:
* type: boolean
* title: include_ancestors_tree
* description: The product category's include ancestors tree.
* include_descendants_tree:
* type: boolean
* title: include_descendants_tree
* description: The product category's include descendants tree.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/store/product-categories/{id}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}",
* "include_ancestors_tree": true,
* "include_descendants_tree": false
* }'
* tags:
* - Product Categories
* 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"
*
*/
www/utils/generated/oas-output/operations/store/get_store_products.ts
+32
View File
@@ -0,0 +1,32 @@
/**
* @oas [get] /store/products
* operationId: GetProducts
* summary: List Products
* description: Retrieve a list of products. The products can be filtered by fields
* such as `id`. The products can also be sorted or paginated.
* x-authenticated: false
* parameters: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/products'
* tags:
* - Products
* 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"
*
*/
www/utils/generated/oas-output/operations/store/get_store_products_[id].ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /store/products/{id}
* operationId: GetProductsId
* summary: Get a Product
* description: Retrieve a product by its ID. You can expand the product's
* relations or select the fields that should be returned.
* x-authenticated: false
* parameters:
* - name: id
* in: path
* description: The product's ID.
* required: true
* schema:
* type: string
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/products/{id}'
* tags:
* - Products
* 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"
*
*/
www/utils/generated/oas-output/operations/store/get_store_regions.ts
+74
View File
@@ -0,0 +1,74 @@
/**
* @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:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/regions'
* tags:
* - Regions
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts
+80
View File
@@ -0,0 +1,80 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/regions/{id}'
* tags:
* - Regions
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/get_store_shipping-options_[cart_id].ts
+80
View File
@@ -0,0 +1,80 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl '{backend_url}/store/shipping-options/{cart_id}'
* tags:
* - Shipping Options
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts.ts
+78
View File
@@ -0,0 +1,78 @@
/**
* @oas [post] /store/carts
* operationId: PostCarts
* summary: Create Cart
* description: Create a cart.
* x-authenticated: false
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateCartWorkflowInput"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts
+84
View File
@@ -0,0 +1,84 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateCartData"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts
+97
View File
@@ -0,0 +1,97 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/line-items'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - variant_id
* - quantity
* - metadata
* properties:
* variant_id:
* type: string
* title: variant_id
* description: The cart's variant id.
* quantity:
* type: number
* title: quantity
* description: The cart's quantity.
* metadata:
* type: object
* description: The cart's metadata.
* properties: {}
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts
+98
View File
@@ -0,0 +1,98 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - quantity
* - metadata
* properties:
* quantity:
* type: number
* title: quantity
* description: The cart's quantity.
* metadata:
* type: object
* description: The cart's metadata.
* properties: {}
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts
+246
View File
@@ -0,0 +1,246 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateCartData"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/payment-collections'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - region_id
* - email
* - billing_address
* - shipping_address
* - sales_channel_id
* - metadata
* - promo_codes
* properties:
* region_id:
* type: string
* title: region_id
* description: The cart's region id.
* email:
* type: string
* title: email
* description: The cart's email.
* format: email
* billing_address:
* oneOf:
* - type: string
* title: billing_address
* description: The cart's billing address.
* - type: object
* description: The cart's billing address.
* required:
* - first_name
* - last_name
* - phone
* - company
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - metadata
* properties:
* first_name:
* type: string
* title: first_name
* description: The billing address's first name.
* last_name:
* type: string
* title: last_name
* description: The billing address's last name.
* phone:
* type: string
* title: phone
* description: The billing address's phone.
* company:
* type: string
* title: company
* description: The billing address's company.
* address_1:
* type: string
* title: address_1
* description: The billing address's address 1.
* address_2:
* type: string
* title: address_2
* description: The billing address's address 2.
* city:
* type: string
* title: city
* description: The billing address's city.
* country_code:
* type: string
* title: country_code
* description: The billing address's country code.
* province:
* type: string
* title: province
* description: The billing address's province.
* postal_code:
* type: string
* title: postal_code
* description: The billing address's postal code.
* metadata:
* type: object
* description: The billing address's metadata.
* properties: {}
* shipping_address:
* oneOf:
* - type: string
* title: shipping_address
* description: The cart's shipping address.
* - type: object
* description: The cart's shipping address.
* required:
* - first_name
* - last_name
* - phone
* - company
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - metadata
* properties:
* first_name:
* type: string
* title: first_name
* description: The shipping address's first name.
* last_name:
* type: string
* title: last_name
* description: The shipping address's last name.
* phone:
* type: string
* title: phone
* description: The shipping address's phone.
* company:
* type: string
* title: company
* description: The shipping address's company.
* address_1:
* type: string
* title: address_1
* description: The shipping address's address 1.
* address_2:
* type: string
* title: address_2
* description: The shipping address's address 2.
* city:
* type: string
* title: city
* description: The shipping address's city.
* country_code:
* type: string
* title: country_code
* description: The shipping address's country code.
* province:
* type: string
* title: province
* description: The shipping address's province.
* postal_code:
* type: string
* title: postal_code
* description: The shipping address's postal code.
* metadata:
* type: object
* description: The shipping address's metadata.
* properties: {}
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The cart's sales channel id.
* metadata:
* type: object
* description: The cart's metadata.
* properties: {}
* promo_codes:
* type: array
* description: The cart's promo codes.
* items:
* type: string
* title: promo_codes
* description: The promo code's promo codes.
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts
+90
View File
@@ -0,0 +1,90 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/promotions'
* tags:
* - Carts
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - promo_codes
* properties:
* promo_codes:
* type: array
* description: The cart's promo codes.
* items:
* type: string
* title: promo_codes
* description: The promo code's promo codes.
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts
+61
View File
@@ -0,0 +1,61 @@
/**
* @oas [post] /store/carts/{id}/shipping-methods
* operationId: PostCartsIdShippingMethods
* summary: Add Shipping Methods to Cart
* description: Add a list of shipping methods 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:
* type: object
* description: SUMMARY
* required:
* - option_id
* - data
* properties:
* option_id:
* type: string
* title: option_id
* description: The cart's option id.
* data:
* type: object
* description: The cart's data.
* properties: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "option_id": "{value}",
* "data": {}
* }'
* 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"
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts
+88
View File
@@ -0,0 +1,88 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* fields:
* type: string
* title: fields
* description: The cart's fields.
* required:
* - fields
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/carts/{id}/taxes'
* tags:
* - Carts
* responses:
* "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"
*
*/
www/utils/generated/oas-output/operations/store/post_store_customers.ts
+102
View File
@@ -0,0 +1,102 @@
/**
* @oas [post] /store/customers
* operationId: PostCustomers
* summary: Create Customer
* description: Create a customer.
* x-authenticated: false
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/customers'
* tags:
* - Customers
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - email
* - company_name
* - first_name
* - last_name
* - phone
* properties:
* email:
* type: string
* title: email
* description: The customer's email.
* format: email
* company_name:
* type: string
* title: company_name
* description: The customer's company name.
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
*
*/
www/utils/generated/oas-output/operations/store/post_store_customers_me.ts
+67
View File
@@ -0,0 +1,67 @@
/**
* @oas [post] /store/customers/me
* operationId: PostCustomersMe
* summary: Create Customer
* description: Create a customer.
* x-authenticated: false
* parameters: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - company_name
* - first_name
* - last_name
* - phone
* properties:
* company_name:
* type: string
* title: company_name
* description: The customer's company name.
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/store/customers/me' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "company_name": "{value}",
* "first_name": "{value}",
* "last_name": "{value}",
* "phone": "{value}"
* }'
* 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"
*
*/
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts
+156
View File
@@ -0,0 +1,156 @@
/**
* @oas [post] /store/customers/me/addresses
* operationId: PostCustomersMeAddresses
* summary: Create Customer
* description: Create a customer.
* x-authenticated: false
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateCustomerAddress"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/store/customers/me/addresses' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "customer_id": "{value}"
* }'
* tags:
* - Customers
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - metadata
* - first_name
* - last_name
* - phone
* - company
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - address_name
* - is_default_shipping
* - is_default_billing
* properties:
* metadata:
* type: object
* description: The customer's metadata.
* properties: {}
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* company:
* type: string
* title: company
* description: The customer's company.
* address_1:
* type: string
* title: address_1
* description: The customer's address 1.
* address_2:
* type: string
* title: address_2
* description: The customer's address 2.
* city:
* type: string
* title: city
* description: The customer's city.
* country_code:
* type: string
* title: country_code
* description: The customer's country code.
* province:
* type: string
* title: province
* description: The customer's province.
* postal_code:
* type: string
* title: postal_code
* description: The customer's postal code.
* address_name:
* type: string
* title: address_name
* description: The customer's address name.
* is_default_shipping:
* type: boolean
* title: is_default_shipping
* description: The customer's is default shipping.
* is_default_billing:
* type: boolean
* title: is_default_billing
* description: The customer's is default billing.
*
*/
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts
+157
View File
@@ -0,0 +1,157 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CustomerAddress"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}'
* tags:
* - Customers
* responses:
* "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"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* required:
* - metadata
* - first_name
* - last_name
* - phone
* - company
* - address_1
* - address_2
* - city
* - country_code
* - province
* - postal_code
* - address_name
* - is_default_shipping
* - is_default_billing
* properties:
* metadata:
* type: object
* description: The customer's metadata.
* properties: {}
* first_name:
* type: string
* title: first_name
* description: The customer's first name.
* last_name:
* type: string
* title: last_name
* description: The customer's last name.
* phone:
* type: string
* title: phone
* description: The customer's phone.
* company:
* type: string
* title: company
* description: The customer's company.
* address_1:
* type: string
* title: address_1
* description: The customer's address 1.
* address_2:
* type: string
* title: address_2
* description: The customer's address 2.
* city:
* type: string
* title: city
* description: The customer's city.
* country_code:
* type: string
* title: country_code
* description: The customer's country code.
* province:
* type: string
* title: province
* description: The customer's province.
* postal_code:
* type: string
* title: postal_code
* description: The customer's postal code.
* address_name:
* type: string
* title: address_name
* description: The customer's address name.
* is_default_shipping:
* type: boolean
* title: is_default_shipping
* description: The customer's is default shipping.
* is_default_billing:
* type: boolean
* title: is_default_billing
* description: The customer's is default billing.
*
*/
www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts
+88
View File
@@ -0,0 +1,88 @@
/**
* @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
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: Comma-separated fields that should be included in the returned data.
* required: false
* schema:
* type: string
* title: fields
* description: Comma-separated fields that should be included in the returned data.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: Field to sort items in the list by.
* required: false
* schema:
* type: string
* title: order
* description: Field to sort items in the list by.
* 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:
* "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"
*
*/