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

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

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-08-15 14:31:35 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 4bd0917aed
commit b23ddcdde8
1211 changed files with 92070 additions and 5062 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts
+12
View File
@@ -69,6 +69,18 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - cart
* properties:
* cart:
* $ref: "#/components/schemas/StoreCart"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts
+27
View File
@@ -74,6 +74,33 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The customer's ID.
* object:
* type: string
* title: object
* description: The customer's object.
* deleted:
* type: boolean
* title: deleted
* description: The customer's deleted.
* parent:
* type: object
* description: The customer's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCartResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_collections.ts
+35
View File
@@ -63,6 +63,41 @@
* tags:
* - Collections
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The collection's limit.
* offset:
* type: number
* title: offset
* description: The collection's offset.
* count:
* type: number
* title: count
* description: The collection's count.
* - type: object
* description: SUMMARY
* required:
* - collections
* properties:
* collections:
* type: array
* description: The collection's collections.
* items:
* $ref: "#/components/schemas/StoreCollection"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Collections
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCollectionResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_currencies.ts
+6
View File
@@ -63,6 +63,12 @@
* tags:
* - Currencies
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCurrencyListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Currencies
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCurrencyResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_customers_me.ts
+6
View File
@@ -68,6 +68,12 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCustomerResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts
+6
View File
@@ -179,6 +179,12 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCustomerAddressListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts
+6
View File
@@ -74,6 +74,12 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCustomerAddressResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_orders.ts
+47 -2
View File
@@ -87,11 +87,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The order's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The order's $or.
* items:
* type: object
* title: $or
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -99,6 +109,41 @@
* tags:
* - Orders
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The order's limit.
* offset:
* type: number
* title: offset
* description: The order's offset.
* count:
* type: number
* title: count
* description: The order's count.
* - type: object
* description: SUMMARY
* required:
* - orders
* properties:
* orders:
* type: array
* description: The order's orders.
* items:
* $ref: "#/components/schemas/StoreOrder"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts
+18 -2
View File
@@ -93,11 +93,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The order's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The order's $or.
* items:
* type: object
* title: $or
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -105,6 +115,12 @@
* tags:
* - Orders
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreOrderResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts
+47 -2
View File
@@ -90,11 +90,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The payment provider's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The payment provider's $or.
* items:
* type: object
* title: $or
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -102,6 +112,41 @@
* tags:
* - Payment Providers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The payment provider's limit.
* offset:
* type: number
* title: offset
* description: The payment provider's offset.
* count:
* type: number
* title: count
* description: The payment provider's count.
* - type: object
* description: SUMMARY
* required:
* - payment_providers
* properties:
* payment_providers:
* type: array
* description: The payment provider's payment providers.
* items:
* $ref: "#/components/schemas/StorePaymentProvider"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_product-categories.ts
+12 -2
View File
@@ -242,11 +242,21 @@
* - name: $and
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The product category's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema: {}
* schema:
* type: array
* description: The product category's $or.
* items:
* type: object
* title: $or
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/store/get_store_products.ts
+6234 -155
View File
File diff suppressed because it is too large Load Diff
www/utils/generated/oas-output/operations/store/get_store_products_[id].ts
+6
View File
@@ -101,6 +101,12 @@
* tags:
* - Products
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreProductResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_regions.ts
+35
View File
@@ -63,6 +63,41 @@
* tags:
* - Regions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The region's limit.
* offset:
* type: number
* title: offset
* description: The region's offset.
* count:
* type: number
* title: count
* description: The region's count.
* - type: object
* description: SUMMARY
* required:
* - regions
* properties:
* regions:
* type: array
* description: The region's regions.
* items:
* $ref: "#/components/schemas/StoreRegion"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts
+12
View File
@@ -69,6 +69,18 @@
* tags:
* - Regions
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - region
* properties:
* region:
* $ref: "#/components/schemas/StoreRegion"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts
+35
View File
@@ -64,6 +64,41 @@
* tags:
* - Return Reasons
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* allOf:
* - type: object
* description: SUMMARY
* required:
* - limit
* - offset
* - count
* properties:
* limit:
* type: number
* title: limit
* description: The return reason's limit.
* offset:
* type: number
* title: offset
* description: The return reason's offset.
* count:
* type: number
* title: count
* description: The return reason's count.
* - type: object
* description: SUMMARY
* required:
* - return_reasons
* properties:
* return_reasons:
* type: array
* description: The return reason's return reasons.
* items:
* $ref: "#/components/schemas/StoreReturnReason"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts
+6
View File
@@ -69,6 +69,12 @@
* tags:
* - Return Reasons
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreReturnReasonResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts
+7
View File
@@ -64,6 +64,12 @@
* tags:
* - Shipping Options
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreShippingOptionListResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -76,6 +82,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: listShippingOptionsForCartWorkflow
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts.ts
+65 -1
View File
@@ -59,7 +59,64 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/CreateCartWorkflowInput"
* description: SUMMARY
* properties:
* region_id:
* type: string
* title: region_id
* description: The cart's region id.
* customer_id:
* type: string
* title: customer_id
* description: The cart's customer id.
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The cart's sales channel id.
* email:
* type: string
* title: email
* description: The cart's email.
* format: email
* currency_code:
* type: string
* title: currency_code
* description: The cart's currency code.
* shipping_address_id:
* type: string
* title: shipping_address_id
* description: The cart's shipping address id.
* billing_address_id:
* type: string
* title: billing_address_id
* description: The cart's billing address id.
* shipping_address:
* oneOf:
* - type: string
* title: shipping_address
* description: The cart's shipping address.
* - $ref: "#/components/schemas/CreateCartAddress"
* billing_address:
* oneOf:
* - type: string
* title: billing_address
* description: The cart's billing address.
* - $ref: "#/components/schemas/CreateCartAddress"
* metadata:
* type: object
* description: The cart's metadata.
* items:
* type: array
* description: The cart's items.
* items:
* $ref: "#/components/schemas/CreateCartCreateLineItem"
* promo_codes:
* type: array
* description: The cart's promo codes.
* items:
* type: string
* title: promo_codes
* description: The promo code's promo codes.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -67,6 +124,12 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCartResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -79,6 +142,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: createCartWorkflow
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts
+54 -1
View File
@@ -65,7 +65,48 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/UpdateCartData"
* description: SUMMARY
* properties:
* region_id:
* type: string
* title: region_id
* description: The cart's region id.
* customer_id:
* type: string
* title: customer_id
* description: The cart's customer id.
* sales_channel_id:
* type: string
* title: sales_channel_id
* description: The cart's sales channel id.
* email:
* type: string
* title: email
* description: The cart's email.
* format: email
* currency_code:
* type: string
* title: currency_code
* description: The cart's currency code.
* shipping_address_id:
* type: string
* title: shipping_address_id
* description: The cart's shipping address id.
* billing_address_id:
* type: string
* title: billing_address_id
* description: The cart's billing address id.
* billing_address:
* oneOf:
* - $ref: "#/components/schemas/CreateAddress"
* - $ref: "#/components/schemas/UpdateAddress"
* shipping_address:
* oneOf:
* - $ref: "#/components/schemas/CreateAddress"
* - $ref: "#/components/schemas/UpdateAddress"
* metadata:
* type: object
* description: The cart's metadata.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -73,6 +114,18 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - cart
* properties:
* cart:
* $ref: "#/components/schemas/StoreCart"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts
+52
View File
@@ -79,6 +79,57 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* oneOf:
* - type: object
* description: SUMMARY
* required:
* - type
* - cart
* - error
* properties:
* type:
* type: string
* title: type
* description: The cart's type.
* cart:
* $ref: "#/components/schemas/StoreCart"
* error:
* type: object
* description: The cart's error.
* required:
* - message
* - name
* - type
* properties:
* message:
* type: string
* title: message
* description: The error's message.
* name:
* type: string
* title: name
* description: The error's name.
* type:
* type: string
* title: type
* description: The error's type.
* - type: object
* description: SUMMARY
* required:
* - type
* - order
* properties:
* type:
* type: string
* title: type
* description: The cart's type.
* order:
* $ref: "#/components/schemas/StoreOrder"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
@@ -91,6 +142,7 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* x-workflow: completeCartWorkflow
*
*/
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts
+6
View File
@@ -80,6 +80,12 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCartResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts
+6
View File
@@ -85,6 +85,12 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCartResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts
+6
View File
@@ -91,6 +91,12 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCartResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts
+6
View File
@@ -89,6 +89,12 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCartResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts
+6
View File
@@ -73,6 +73,12 @@
* tags:
* - Carts
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCartResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_customers.ts
+6
View File
@@ -76,6 +76,12 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCustomerResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_customers_me.ts
+6
View File
@@ -79,6 +79,12 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCustomerResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts
+6
View File
@@ -157,6 +157,12 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCustomerResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts
+6
View File
@@ -163,6 +163,12 @@
* tags:
* - Customers
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreCustomerResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts
+6 -15
View File
@@ -63,26 +63,11 @@
* description: SUMMARY
* required:
* - cart_id
* - region_id
* - currency_code
* - amount
* properties:
* cart_id:
* type: string
* title: cart_id
* description: The payment collection's cart id.
* region_id:
* type: string
* title: region_id
* description: The payment collection's region id.
* currency_code:
* type: string
* title: currency_code
* description: The payment collection's currency code.
* amount:
* type: number
* title: amount
* description: The payment collection's amount.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -98,6 +83,12 @@
* tags:
* - Payment Collections
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StorePaymentCollectionResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts
+6
View File
@@ -95,6 +95,12 @@
* tags:
* - Payment Collections
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StorePaymentCollectionResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/store/post_store_return.ts
+6
View File
@@ -86,6 +86,12 @@
* tags:
* - Return
* responses:
* "200":
* description: OK
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/StoreReturnResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":