diff --git a/docs-util/oas-output/base-v2/admin.oas.base.yaml b/docs-util/oas-output/base-v2/admin.oas.base.yaml index 01289e50e9..a8c09e3ff9 100644 --- a/docs-util/oas-output/base-v2/admin.oas.base.yaml +++ b/docs-util/oas-output/base-v2/admin.oas.base.yaml @@ -6,33 +6,9 @@ info: name: MIT url: https://github.com/medusajs/medusa/blob/master/LICENSE tags: - - name: Apps Oauth - description: > - Some plugins may require to authenticate with third-party services and - store authentication details, such as the authentication token. To do - that, they can create an Oauth provider within the plugin that handles the - authentication. - - The Apps Oauth API Routes allows admins to manage and generate token for an app using its oauth provider. - - name: Auth - description: > - Authentication API Routes allow admin users to manage their session, such - as login or log out. - - When an admin user is logged in, the cookie header is set indicating the admin's login session. - externalDocs: - description: How to implement user profiles - url: https://docs.medusajs.com/modules/users/admin/manage-profile - - name: Batch Jobs - description: > - A batch job is a task that is performed by the Medusa backend - asynchronusly. For example, the Import Product feature is implemented - using batch jobs. - - Batch Job API Routes allow admins to manage the batch jobs and their state. - externalDocs: - description: How to import products - url: https://docs.medusajs.com/modules/products/admin/import-products + - name: Api Keys + - name: Campaigns + - name: Collections - name: Currencies description: > A store can use unlimited currencies, and each region must be associated @@ -58,31 +34,7 @@ tags: externalDocs: description: How to manage customers url: https://docs.medusajs.com/modules/customers/admin/manage-customers - - name: Discounts - description: > - Admins can create discounts with conditions and rules, providing them with - advanced settings for variety of cases. - - The Discount API Routes can be used to manage discounts, their conditions, resources, and more. - externalDocs: - description: How to manage discounts - url: https://docs.medusajs.com/modules/discounts/admin/manage-discounts - - name: Draft Orders - description: > - A draft order is an order created manually by the admin. It allows admins - to create orders without direct involvement from the customer. - externalDocs: - description: How to manage draft orders - url: https://docs.medusajs.com/modules/orders/admin/manage-draft-orders - - name: Gift Cards - description: > - Admins can create gift cards and send them directly to customers, - specifying options like their balance, region, and more. - - These gift cards are different than the saleable gift cards in a store, which are created and managed through Product API Routes. - externalDocs: - description: How to manage gift cards - url: https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-custom-gift-cards + - name: Fulfillment - name: Inventory Items description: > Inventory items, provided by the [Inventory @@ -98,39 +50,6 @@ tags: externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites - - name: Notes - description: > - Notes are created by admins and can be associated with any resource. For - example, an admin can add a note to an order for additional details or - remarks. - - name: Notifications - description: > - Notifications are sent to customers to inform them of new updates. For - example, a notification can be sent to the customer when their order is - place or its state is updated. - - The notification's type, such as an email or SMS, is determined by the notification provider installed on the Medusa backend. - - name: Order Edits - description: > - An admin can edit an order to remove, add, or update an item's quantity. - When an admin edits an order, they're stored as an `OrderEdit`. - externalDocs: - description: How to edit an order - url: https://docs.medusajs.com/modules/orders/admin/edit-order - - name: Orders - description: > - Orders are purchases made by customers, typically through a storefront - using the Store API. Draft orders created by the admin are also - transformed to an Order once the payment is captured. - - Managing orders include managing fulfillment, payment, claims, reservations, and more. - externalDocs: - description: How to manage orders - url: https://docs.medusajs.com/modules/orders/admin/manage-orders - - name: Payment Collections - description: > - A payment collection is useful for managing additional payments, such as - for Order Edits, or installment payments. - name: Payments description: > A payment can be related to an order, swap, return, or more. It can be @@ -142,39 +61,7 @@ tags: externalDocs: description: How to manage price lists url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists - - name: Product Categories - description: > - Products can be categoriezed into categories. A product can be added into - more than one category. - externalDocs: - description: How to manage product categories - url: https://docs.medusajs.com/modules/products/admin/manage-categories - - name: Product Collections - description: > - A product collection is used to organize products for different purposes - such as marketing or discount purposes. For example, you can create a - Summer Collection. - - name: Product Tags - description: > - Product tags are string values created when you create or update a product - with a new tag. - - Products can have more than one tag, and products can share tags. This allows admins to associate products to similar tags that can be used to filter products. - - name: Product Types - description: > - Product types are string values created when you create or update a - product with a new type. - - Products can have one type, and products can share types. This allows admins to associate products with a type that can be used to filter products. - - name: Product Variants - description: > - Product variants are the actual salable item in your store. Each variant - is a combination of the different option values available on the product. - - Product variants can be managed through the Products API Routes. - externalDocs: - description: How to manage product variants - url: https://docs.medusajs.com/modules/products/admin/manage-products#manage-product-variants + - name: Pricing - name: Products description: > Products are saleable items in a store. This also includes [saleable gift @@ -183,19 +70,7 @@ tags: externalDocs: description: How to manage products url: https://docs.medusajs.com/modules/products/admin/manage-products - - name: Publishable API Keys - description: > - Publishable API Keys can be used to scope Store API calls with an API key, - determining what resources are retrieved when querying the API. - - For example, a publishable API key can be associated with one or more sales channels. When it is passed in the header of a request to the List Product store API Route, - - the sales channels are inferred from the key and only products associated with those sales channels are retrieved. - - Admins can manage publishable API keys and their associated resources. Currently, only Sales Channels are supported as a resource. - externalDocs: - description: How to manage publishable API keys - url: https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys + - name: Promotions - name: Regions description: > Regions are different countries or geographical regions that the commerce @@ -205,35 +80,6 @@ tags: externalDocs: description: How to manage regions url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions - - name: Reservations - description: > - Reservations, provided by the [Inventory - Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), - are quantities of an item that are reserved, typically when an order is - placed but not yet fulfilled. - - Reservations can be associated with any resources, but commonly with line items of an order. - externalDocs: - description: How to manage item allocations in orders - url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-item-allocations-in-orders - - name: Return Reasons - description: > - Return reasons are key-value pairs that are used to specify why an order - return is being created. - - Admins can manage available return reasons, and they can be used by both admins and customers when creating a return. - externalDocs: - description: How to manage return reasons - url: https://docs.medusajs.com/modules/orders/admin/manage-returns#manage-return-reasons - - name: Returns - description: > - A return can be created by a customer or an admin to return items in an - order. - - Admins can manage these returns and change their state. - externalDocs: - description: How to manage returns - url: https://docs.medusajs.com/modules/orders/admin/manage-returns - name: Sales Channels description: > A sales channel indicates a channel where products can be sold in. For @@ -243,50 +89,7 @@ tags: externalDocs: description: How to manage sales channels url: https://docs.medusajs.com/modules/sales-channels/admin/manage - - name: Shipping Options - description: > - A shipping option is used to define the available shipping methods during - checkout or when creating a return. - - Admins can create an unlimited number of shipping options, each associated with a shipping profile and fulfillment provider, among other resources. - externalDocs: - description: Shipping Option architecture - url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option - - name: Shipping Profiles - description: > - A shipping profile is used to group products that can be shipped in the - same manner. - - They are created by the admin and they're not associated with a fulfillment provider. - externalDocs: - description: Shipping Profile architecture - url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-profile - - name: Stock Locations - description: > - A stock location, provided by the [Stock Location - module](https://docs.medusajs.com/modules/multiwarehouse/stock-location-module), - indicates a physical address that stock-kept items, such as physical - products, can be stored in. - - An admin can create and manage available stock locations. - externalDocs: - description: How to manage stock locations. - url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-stock-locations - - name: Store - description: > - A store indicates the general configurations and details about the - commerce store. By default, there's only one store in the Medusa backend. - - Admins can manage the store and its details or configurations. - - name: Swaps - description: > - A swap is created by a customer or an admin to exchange an item with a new - one. - - Creating a swap implicitely includes creating a return for the item being exchanged. - externalDocs: - description: How to manage swaps - url: https://docs.medusajs.com/modules/orders/admin/manage-swaps + - name: Stores - name: Tax Rates description: > Each region has at least a default tax rate. Admins can create and manage @@ -295,14 +98,7 @@ tags: externalDocs: description: How to manage tax rates url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates - - name: Uploads - description: > - The upload API Routes are used to upload any type of resources. For - example, they can be used to upload CSV files that are used to import - products into the store. - externalDocs: - description: How to upload CSV file when importing a product. - url: https://docs.medusajs.com/modules/products/admin/import-products#1-upload-csv-file + - name: Tax Regions - name: Users description: > A store can have more than one user, each having the same privileges. @@ -310,6 +106,7 @@ tags: externalDocs: description: How to manage users url: https://docs.medusajs.com/modules/users/admin/manage-users + - name: Workflows Executions servers: - url: http://localhost:9000 - url: https://api.medusa-commerce.com diff --git a/docs-util/oas-output/base-v2/store.oas.base.yaml b/docs-util/oas-output/base-v2/store.oas.base.yaml index 5eef2be5c3..8403c4fcf2 100644 --- a/docs-util/oas-output/base-v2/store.oas.base.yaml +++ b/docs-util/oas-output/base-v2/store.oas.base.yaml @@ -6,112 +6,47 @@ info: name: MIT url: https://github.com/medusajs/medusa/blob/master/LICENSE tags: - - name: Auth - description: | - Authentication API Routes allow you to manage a customer's session, such as login or log out. - You can send authenticated requests for a customer either using the Cookie header or using the JWT Token. - externalDocs: - description: How to implement customer profiles in your storefront - url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles - name: Carts - description: | - A cart is a virtual shopping bag that customers can use to add items they want to purchase. + description: > + A cart is a virtual shopping bag that customers can use to add items they + want to purchase. + A cart is then used to checkout and place an order. externalDocs: description: How to implement cart functionality in your storefront url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart + - name: Currencies - name: Customers - description: | - A customer can register and manage their information such as addresses, orders, payment methods, and more. + description: > + A customer can register and manage their information such as addresses, + orders, payment methods, and more. externalDocs: description: How to implement customer profiles in your storefront url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles - - name: Gift Cards - description: | - Customers can use gift cards during checkout to deduct the gift card's balance from the checkout total. - The Gift Card API Routes allow retrieving a gift card's details by its code. A gift card can be applied to a cart using the Carts API Routes. - externalDocs: - description: How to use gift cards in a storefront - url: https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards - - name: Orders - description: | - Orders are purchases made by customers, typically through a storefront. - Orders are placed and created using the Carts API Routes. The Orders API Routes allow retrieving and claiming orders. - externalDocs: - description: How to retrieve order details in a storefront - url: https://docs.medusajs.com/modules/orders/storefront/retrieve-order-details - - name: Order Edits - description: | - Order edits are changes made to items in an order such as adding, updating their quantity, or deleting them. Order edits are created by the admin. - A customer can review order edit requests created by an admin and confirm or decline them. - externalDocs: - description: How to handle order edits in a storefront - url: https://docs.medusajs.com/modules/orders/storefront/handle-order-edits - name: Payment Collections - description: | - A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. - - name: Products - description: | - Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards) in a store. - Using these API Routes, you can filter products by categories, collections, sales channels, and more. - externalDocs: - description: How to show products in a storefront - url: https://docs.medusajs.com/modules/products/storefront/show-products - - name: Product Variants - description: | - Product variants are the actual salable item in your store. Each variant is a combination of the different option values available on the product. - - name: Product Categories - description: | - Products can be categoriezed into categories. A product can be associated more than one category. - Using these API Routes, you can list or retrieve a category's details and products. - externalDocs: - description: How to use product categories in a storefront - url: https://docs.medusajs.com/modules/products/storefront/use-categories - - name: Product Collections - description: | - A product collection is used to organize products for different purposes such as marketing or discount purposes. For example, you can create a Summer Collection. - Using these API Routes, you can list or retrieve a collection's details and products. - - name: Product Tags - description: | - Product tags are string values that can be used to filter products by. - Products can have more than one tag, and products can share tags. - - name: Product Types - description: | - Product types are string values that can be used to filter products by. - Products can have more than one tag, and products can share types. + description: > + A payment collection is useful for managing additional payments, such as + for Order Edits, or installment payments. - name: Regions - description: | - Regions are different countries or geographical regions that the commerce store serves customers in. + description: > + Regions are different countries or geographical regions that the commerce + store serves customers in. + Customers can choose what region they're in, which can be used to change the prices shown based on the region and its currency. externalDocs: description: How to use regions in a storefront url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions - - name: Returns - description: | - A return can be created by a customer to return items in an order. - externalDocs: - description: How to create a return in a storefront - url: https://docs.medusajs.com/modules/orders/storefront/create-return - - name: Return Reasons - description: | - Return reasons are key-value pairs that are used to specify why an order return is being created. - name: Shipping Options - description: | - A shipping option is used to define the available shipping methods during checkout or when creating a return. + description: > + A shipping option is used to define the available shipping methods during + checkout or when creating a return. externalDocs: description: Shipping Option architecture url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option - - name: Swaps - description: | - A swap is created by a customer or an admin to exchange an item with a new one. - Creating a swap implicitely includes creating a return for the item being exchanged. - externalDocs: - description: How to create a swap in a storefront - url: https://docs.medusajs.com/modules/orders/storefront/create-swap servers: - url: http://localhost:9000 - url: https://api.medusa-commerce.com -paths: { } +paths: {} components: responses: default_error: @@ -121,9 +56,9 @@ components: schema: $ref: "#/components/schemas/Error" example: - code: "unknown_error" - message: "An unknown error occurred." - type: "unknown_error" + code: unknown_error + message: An unknown error occurred. + type: unknown_error invalid_state_error: description: Invalid State Error content: @@ -131,9 +66,10 @@ components: schema: $ref: "#/components/schemas/Error" example: - code: "unknown_error" - message: "The request conflicted with another request. You may retry the request with the provided Idempotency-Key." - type: "QueryRunnerAlreadyReleasedError" + code: unknown_error + message: The request conflicted with another request. You may retry the request + with the provided Idempotency-Key. + type: QueryRunnerAlreadyReleasedError invalid_request_error: description: Invalid Request Error content: @@ -141,9 +77,9 @@ components: schema: $ref: "#/components/schemas/Error" example: - code: "invalid_request_error" - message: "Discount with code TEST already exists." - type: "duplicate_error" + code: invalid_request_error + message: Discount with code TEST already exists. + type: duplicate_error not_found_error: description: Not Found Error content: @@ -151,8 +87,8 @@ components: schema: $ref: "#/components/schemas/Error" example: - message: "Entity with id 1 was not found" - type: "not_found" + message: Entity with id 1 was not found + type: not_found 400_error: description: Client Error or Multiple Errors content: @@ -184,7 +120,7 @@ components: default_error: $ref: "#/components/examples/default_error" unauthorized: - description: 'User is not authorized. Must log in first' + description: User is not authorized. Must log in first content: text/plain: schema: @@ -192,7 +128,7 @@ components: default: Unauthorized example: Unauthorized incorrect_credentials: - description: 'User does not exist or incorrect credentials' + description: User does not exist or incorrect credentials content: text/plain: schema: @@ -203,44 +139,45 @@ components: not_allowed_error: summary: Not Allowed Error value: - message: "Discount must be set to dynamic" - type: "not_allowed" + message: Discount must be set to dynamic + type: not_allowed invalid_data_error: summary: Invalid Data Error value: - message: "first_name must be a string" - type: "invalid_data" + message: first_name must be a string + type: invalid_data multiple_errors: summary: Multiple Errors value: - message: "Provided request body contains errors. Please check the data and retry the request" + message: Provided request body contains errors. Please check the data and retry + the request errors: - - message: "first_name must be a string" - type: "invalid_data" - - message: "Discount must be set to dynamic" - type: "not_allowed" + - message: first_name must be a string + type: invalid_data + - message: Discount must be set to dynamic + type: not_allowed database_error: summary: Database Error value: - code: "api_error" - message: "An error occured while hashing password" - type: "database_error" + code: api_error + message: An error occured while hashing password + type: database_error unexpected_state_error: summary: Unexpected State Error value: - message: "cart.total must be defined" - type: "unexpected_state" + message: cart.total must be defined + type: unexpected_state invalid_argument_error: summary: Invalid Argument Error value: - message: "cart.total must be defined" - type: "unexpected_state" + message: cart.total must be defined + type: unexpected_state default_error: summary: Default Error value: - code: "unknown_error" - message: "An unknown error occurred." - type: "unknown_error" + code: unknown_error + message: An unknown error occurred. + type: unknown_error securitySchemes: jwt_token: type: http @@ -251,37 +188,56 @@ components: x-displayName: Cookie Session ID in: cookie name: connect.sid - description: | + description: > Use a cookie session to send authenticated requests. + ### How to Obtain the Cookie Session + If you're sending requests through a browser, using JS Client, or using tools like Postman, the cookie session should be automatically set when the customer is logged in. + If you're sending requests using cURL, you must set the Session ID in the cookie manually. + To do that, send a request to [authenticate the customer](#tag/Auth/operation/PostAuth) and pass the cURL option `-v`: + ```bash + curl -v --location --request POST 'https://medusa-url.com/store/auth' \ + --header 'Content-Type: application/json' \ + --data-raw '{ "email": "user@example.com", "password": "supersecret" }' + ``` + The headers will be logged in the terminal as well as the response. You should find in the headers a Cookie header similar to this: + ```bash + Set-Cookie: connect.sid=s%3A2Bu8BkaP9JUfHu9rG59G16Ma0QZf6Gj1.WT549XqX37PN8n0OecqnMCq798eLjZC5IT7yiDCBHPM; + ``` + Copy the value after `connect.sid` (without the `;` at the end) and pass it as a cookie in subsequent requests as the following: + ```bash + curl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \ + --header 'Cookie: connect.sid={sid}' + ``` - - Where `{sid}` is the value of `connect.sid` that you copied. \ No newline at end of file + + + Where `{sid}` is the value of `connect.sid` that you copied. diff --git a/docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts new file mode 100644 index 0000000000..8e46e3c925 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/api-keys/{id} + * operationId: DeleteApiKeysId + * summary: Delete a Api Key + * description: Delete a api key. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The api key's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/api-keys/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Api Keys + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts new file mode 100644 index 0000000000..037bbcc078 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/campaigns/{id} + * operationId: DeleteCampaignsId + * summary: Delete a Campaign + * description: Delete a campaign. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The campaign's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/campaigns/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Campaigns + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts new file mode 100644 index 0000000000..c4f6f50b28 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/collections/{id} + * operationId: DeleteCollectionsId + * summary: Delete a Collection + * description: Delete a collection. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The collection's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/collections/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts new file mode 100644 index 0000000000..422af2bb85 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/customer-groups/{id} + * operationId: DeleteCustomerGroupsId + * summary: Delete a Customer Group + * description: Delete a customer group. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer group's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/customer-groups/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Customer Groups + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts new file mode 100644 index 0000000000..327656a70a --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/customers/{id} + * operationId: DeleteCustomersId + * summary: Delete a Customer + * description: Delete a customer. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/customers/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts new file mode 100644 index 0000000000..4b41d802f8 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -0,0 +1,52 @@ +/** + * @oas [delete] /admin/customers/{id}/addresses/{address_id} + * operationId: DeleteCustomersIdAddressesAddress_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: true + * parameters: + * - name: id + * in: path + * description: The customer's ID. + * required: true + * schema: + * type: string + * - name: address_id + * in: path + * description: The customer's address id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts new file mode 100644 index 0000000000..e271e9d938 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/inventory-items/{id} + * operationId: DeleteInventoryItemsId + * summary: Delete a Inventory Item + * description: Delete a inventory item. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The inventory item's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/inventory-items/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Inventory Items + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts b/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts new file mode 100644 index 0000000000..20cdd23e3b --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -0,0 +1,53 @@ +/** + * @oas [delete] /admin/inventory-items/{id}/location-levels/{location_id} + * operationId: DeleteInventoryItemsIdLocationLevelsLocation_id + * summary: Remove Location Levels from Inventory Item + * description: Remove a list of location levels from a inventory item. This + * doesn't delete the Location Level, only the association between the Location + * Level and the inventory item. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The inventory item's ID. + * required: true + * schema: + * type: string + * - name: location_id + * in: path + * description: The inventory item's location id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Inventory Items + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts new file mode 100644 index 0000000000..bbfb6be5be --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/invites/{id} + * operationId: DeleteInvitesId + * summary: Delete a Invite + * description: Delete a invite. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The invite's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/invites/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Invites + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts new file mode 100644 index 0000000000..96758341fe --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/price-lists/{id} + * operationId: DeletePriceListsId + * summary: Delete a Price List + * description: Delete a price list. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The price list's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/price-lists/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Price Lists + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts new file mode 100644 index 0000000000..79fbe40d11 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts @@ -0,0 +1,49 @@ +/** + * @oas [delete] /admin/pricing/rule-types/{id} + * operationId: DeletePricingRuleTypesId + * summary: Remove Rule Types from Pricing + * description: Remove a list of rule types from a pricing. This doesn't delete the + * Rule Type, only the association between the Rule Type and the pricing. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The pricing's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/pricing/rule-types/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Pricing + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_products_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_products_[id].ts new file mode 100644 index 0000000000..00b871e3ab --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_products_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/products/{id} + * operationId: DeleteProductsId + * summary: Delete a Product + * description: Delete a product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/products/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts b/docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts new file mode 100644 index 0000000000..ce69c294b5 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts @@ -0,0 +1,50 @@ +/** + * @oas [delete] /admin/products/{id}/options/{option_id} + * operationId: DeleteProductsIdOptionsOption_id + * summary: Remove Options from Product + * description: Remove a list of options from a product. This doesn't delete the + * Option, only the association between the Option and the product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: option_id + * in: path + * description: The product's option id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/products/{id}/options/{option_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts b/docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts new file mode 100644 index 0000000000..b71c015804 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts @@ -0,0 +1,50 @@ +/** + * @oas [delete] /admin/products/{id}/variants/{variant_id} + * operationId: DeleteProductsIdVariantsVariant_id + * summary: Remove Variants from Product + * description: Remove a list of variants from a product. This doesn't delete the + * Variant, only the association between the Variant and the product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: variant_id + * in: path + * description: The product's variant id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts new file mode 100644 index 0000000000..ef9685083e --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/promotions/{id} + * operationId: DeletePromotionsId + * summary: Delete a Promotion + * description: Delete a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/promotions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts new file mode 100644 index 0000000000..8760584f30 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/regions/{id} + * operationId: DeleteRegionsId + * summary: Delete a Region + * description: Delete a region. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The region's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/regions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts new file mode 100644 index 0000000000..0ab3c8c393 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/sales-channels/{id} + * operationId: DeleteSalesChannelsId + * summary: Delete a Sales Channel + * description: Delete a sales channel. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The sales channel's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/sales-channels/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Sales Channels + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts new file mode 100644 index 0000000000..17936cd834 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/tax-rates/{id} + * operationId: DeleteTaxRatesId + * summary: Delete a Tax Rate + * description: Delete a tax rate. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The tax rate's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/tax-rates/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Tax Rates + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts b/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts new file mode 100644 index 0000000000..6902c13233 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts @@ -0,0 +1,50 @@ +/** + * @oas [delete] /admin/tax-rates/{id}/rules/{rule_id} + * operationId: DeleteTaxRatesIdRulesRule_id + * summary: Remove Rules from Tax Rate + * description: Remove a list of rules from a tax rate. This doesn't delete the + * Rule, only the association between the Rule and the tax rate. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The tax rate's ID. + * required: true + * schema: + * type: string + * - name: rule_id + * in: path + * description: The tax rate's rule id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/tax-rates/{id}/rules/{rule_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Tax Rates + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts new file mode 100644 index 0000000000..3d0277f934 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/tax-regions/{id} + * operationId: DeleteTaxRegionsId + * summary: Delete a Tax Region + * description: Delete a tax region. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The tax region's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/tax-regions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Tax Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/delete_admin_users_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_users_[id].ts new file mode 100644 index 0000000000..bb03b13ce6 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_users_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/users/{id} + * operationId: DeleteUsersId + * summary: Delete a User + * description: Delete a user. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The user's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/users/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Users + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_api-keys.ts b/docs-util/oas-output/operations/admin/get_admin_api-keys.ts new file mode 100644 index 0000000000..bf3ed4d6c2 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_api-keys.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/api-keys + * operationId: GetApiKeys + * summary: List Api Keys + * description: Retrieve a list of api keys. The api keys can be filtered by fields + * such as `id`. The api keys can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/api-keys' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Api Keys + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts b/docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts new file mode 100644 index 0000000000..f326264e5c --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/api-keys/{id} + * operationId: GetApiKeysId + * summary: Get a Api Key + * description: Retrieve a api key by its ID. You can expand the api key's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The api key's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/api-keys/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Api Keys + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_campaigns.ts b/docs-util/oas-output/operations/admin/get_admin_campaigns.ts new file mode 100644 index 0000000000..83982744e5 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_campaigns.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/campaigns + * operationId: GetCampaigns + * summary: List Campaigns + * description: Retrieve a list of campaigns. The campaigns can be filtered by + * fields such as `id`. The campaigns can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/campaigns' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Campaigns + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts b/docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts new file mode 100644 index 0000000000..035c18516d --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/campaigns/{id} + * operationId: GetCampaignsId + * summary: Get a Campaign + * description: Retrieve a campaign by its ID. You can expand the campaign's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The campaign's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/campaigns/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Campaigns + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_collections.ts b/docs-util/oas-output/operations/admin/get_admin_collections.ts new file mode 100644 index 0000000000..c5b50191e1 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_collections.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/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: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/collections' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_collections_[id].ts b/docs-util/oas-output/operations/admin/get_admin_collections_[id].ts new file mode 100644 index 0000000000..257590214d --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_collections_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/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: true + * parameters: + * - name: id + * in: path + * description: The collection's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/collections/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_currencies.ts b/docs-util/oas-output/operations/admin/get_admin_currencies.ts new file mode 100644 index 0000000000..e44fcdc932 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_currencies.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/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: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/currencies' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Currencies + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts b/docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts new file mode 100644 index 0000000000..df01e2746d --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/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: true + * parameters: + * - name: code + * in: path + * description: The currency's code. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/currencies/{code}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Currencies + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_customer-groups.ts b/docs-util/oas-output/operations/admin/get_admin_customer-groups.ts new file mode 100644 index 0000000000..2e65d74633 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_customer-groups.ts @@ -0,0 +1,39 @@ +/** + * @oas [get] /admin/customer-groups + * operationId: GetCustomerGroups + * summary: List Customer Groups + * description: Retrieve a list of customer groups. The customer groups can be + * filtered by fields such as `id`. The customer groups can also be sorted or + * paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/customer-groups' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Customer Groups + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts b/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts new file mode 100644 index 0000000000..aeabb46508 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/customer-groups/{id} + * operationId: GetCustomerGroupsId + * summary: Get a Customer Group + * description: Retrieve a customer group by its ID. You can expand the customer + * group's relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer group's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/customer-groups/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Customer Groups + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id]_customers.ts b/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id]_customers.ts new file mode 100644 index 0000000000..2ef3ed1b23 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id]_customers.ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/customer-groups/{id}/customers + * operationId: GetCustomerGroupsIdCustomers + * summary: List Customers + * description: Retrieve a list of customers in a customer group. The customers can + * be filtered by fields like FILTER FIELDS. The customers can also be paginated. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer group's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/customer-groups/{id}/customers' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Customer Groups + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_customers.ts b/docs-util/oas-output/operations/admin/get_admin_customers.ts new file mode 100644 index 0000000000..0a06196376 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_customers.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/customers + * operationId: GetCustomers + * 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: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/customers' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_customers_[id].ts b/docs-util/oas-output/operations/admin/get_admin_customers_[id].ts new file mode 100644 index 0000000000..cbd4166891 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_customers_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/customers/{id} + * operationId: GetCustomersId + * summary: Get a Customer + * description: Retrieve a customer by its ID. You can expand the customer's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/customers/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts new file mode 100644 index 0000000000..3067fb7e84 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/customers/{id}/addresses + * operationId: GetCustomersIdAddresses + * 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: true + * parameters: + * - name: id + * in: path + * description: The customer's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/customers/{id}/addresses' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts new file mode 100644 index 0000000000..48a3265eed --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -0,0 +1,50 @@ +/** + * @oas [get] /admin/customers/{id}/addresses/{address_id} + * operationId: GetCustomersIdAddressesAddress_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: true + * parameters: + * - name: id + * in: path + * description: The customer's ID. + * required: true + * schema: + * type: string + * - name: address_id + * in: path + * description: The customer's address id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_inventory-items.ts b/docs-util/oas-output/operations/admin/get_admin_inventory-items.ts new file mode 100644 index 0000000000..e3f91dea9f --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_inventory-items.ts @@ -0,0 +1,39 @@ +/** + * @oas [get] /admin/inventory-items + * operationId: GetInventoryItems + * summary: List Inventory Items + * description: Retrieve a list of inventory items. The inventory items can be + * filtered by fields such as `id`. The inventory items can also be sorted or + * paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/inventory-items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Inventory Items + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts b/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts new file mode 100644 index 0000000000..c15313739e --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/inventory-items/{id} + * operationId: GetInventoryItemsId + * summary: Get a Inventory Item + * description: Retrieve a inventory item by its ID. You can expand the inventory + * item's relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The inventory item's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/inventory-items/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Inventory Items + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_invites.ts b/docs-util/oas-output/operations/admin/get_admin_invites.ts new file mode 100644 index 0000000000..31a21877d7 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_invites.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/invites + * operationId: GetInvites + * summary: List Invites + * description: Retrieve a list of invites. The invites can be filtered by fields + * such as `id`. The invites can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/invites' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Invites + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_invites_[id].ts b/docs-util/oas-output/operations/admin/get_admin_invites_[id].ts new file mode 100644 index 0000000000..5bccf8f2d3 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_invites_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/invites/{id} + * operationId: GetInvitesId + * summary: Get a Invite + * description: Retrieve a invite by its ID. You can expand the invite's relations + * or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The invite's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/invites/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Invites + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_payments.ts b/docs-util/oas-output/operations/admin/get_admin_payments.ts new file mode 100644 index 0000000000..87300b27bc --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_payments.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/payments + * operationId: GetPayments + * summary: List Payments + * description: Retrieve a list of payments. The payments can be filtered by fields + * such as `id`. The payments can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/payments' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Payments + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_payments_[id].ts b/docs-util/oas-output/operations/admin/get_admin_payments_[id].ts new file mode 100644 index 0000000000..4029f5dffe --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_payments_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/payments/{id} + * operationId: GetPaymentsId + * summary: Get a Payment + * description: Retrieve a payment by its ID. You can expand the payment's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The payment's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/payments/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Payments + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_price-lists.ts b/docs-util/oas-output/operations/admin/get_admin_price-lists.ts new file mode 100644 index 0000000000..fe6d2df247 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_price-lists.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/price-lists + * operationId: GetPriceLists + * summary: List Price Lists + * description: Retrieve a list of price lists. The price lists can be filtered by + * fields such as `id`. The price lists can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/price-lists' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Price Lists + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts b/docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts new file mode 100644 index 0000000000..4c001f4804 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/price-lists/{id} + * operationId: GetPriceListsId + * summary: Get a Price List + * description: Retrieve a price list by its ID. You can expand the price list's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The price list's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/price-lists/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Price Lists + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts b/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts new file mode 100644 index 0000000000..f94a6e6a18 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts @@ -0,0 +1,43 @@ +/** + * @oas [get] /admin/pricing/rule-types + * operationId: GetPricingRuleTypes + * summary: List Pricing + * description: Retrieve a list of pricing. The pricing can be filtered by fields + * such as `id`. The pricing can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminGetPricingRuleTypesParams" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/pricing/rule-types' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Pricing + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts b/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts new file mode 100644 index 0000000000..c91227b127 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts @@ -0,0 +1,49 @@ +/** + * @oas [get] /admin/pricing/rule-types/{id} + * operationId: GetPricingRuleTypesId + * summary: List Rule Types + * description: Retrieve a list of rule types in a pricing. The rule types can be + * filtered by fields like FILTER FIELDS. The rule types can also be paginated. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The pricing's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminGetPricingRuleTypesRuleTypeParams" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/pricing/rule-types/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Pricing + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_products.ts b/docs-util/oas-output/operations/admin/get_admin_products.ts new file mode 100644 index 0000000000..47fbe5f01b --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_products.ts @@ -0,0 +1,43 @@ +/** + * @oas [get] /admin/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: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminGetProductsParams" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/products' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id].ts b/docs-util/oas-output/operations/admin/get_admin_products_[id].ts new file mode 100644 index 0000000000..e4390bb590 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/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: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/products/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts b/docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts new file mode 100644 index 0000000000..bcb4cc9e10 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/products/{id}/options + * operationId: GetProductsIdOptions + * summary: List Options + * description: Retrieve a list of options in a product. The options can be + * filtered by fields like FILTER FIELDS. The options can also be paginated. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/products/{id}/options' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts b/docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts new file mode 100644 index 0000000000..2f2ef1ad59 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts @@ -0,0 +1,50 @@ +/** + * @oas [get] /admin/products/{id}/options/{option_id} + * operationId: GetProductsIdOptionsOption_id + * summary: List Options + * description: Retrieve a list of options in a product. The options can be + * filtered by fields like FILTER FIELDS. The options can also be paginated. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: option_id + * in: path + * description: The product's option id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/products/{id}/options/{option_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts b/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts new file mode 100644 index 0000000000..d938115f1b --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/products/{id}/variants + * operationId: GetProductsIdVariants + * summary: List Variants + * description: Retrieve a list of variants in a product. The variants can be + * filtered by fields like FILTER FIELDS. The variants can also be paginated. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/products/{id}/variants' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts b/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts new file mode 100644 index 0000000000..6519a456e5 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts @@ -0,0 +1,50 @@ +/** + * @oas [get] /admin/products/{id}/variants/{variant_id} + * operationId: GetProductsIdVariantsVariant_id + * summary: List Variants + * description: Retrieve a list of variants in a product. The variants can be + * filtered by fields like FILTER FIELDS. The variants can also be paginated. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: variant_id + * in: path + * description: The product's variant id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/products/{id}/variants/{variant_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_promotions.ts b/docs-util/oas-output/operations/admin/get_admin_promotions.ts new file mode 100644 index 0000000000..ed63543b3e --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_promotions.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/promotions + * operationId: GetPromotions + * summary: List Promotions + * description: Retrieve a list of promotions. The promotions can be filtered by + * fields such as `id`. The promotions can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/promotions' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts b/docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts new file mode 100644 index 0000000000..e7ae6920ea --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts @@ -0,0 +1,49 @@ +/** + * @oas [get] /admin/promotions/{id} + * operationId: GetPromotionsId + * summary: Get a Promotion + * description: Retrieve a promotion by its ID. You can expand the promotion's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminGetPromotionsParams" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/promotions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_regions.ts b/docs-util/oas-output/operations/admin/get_admin_regions.ts new file mode 100644 index 0000000000..a915dbaac7 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_regions.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/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: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/regions' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_regions_[id].ts b/docs-util/oas-output/operations/admin/get_admin_regions_[id].ts new file mode 100644 index 0000000000..455da03456 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_regions_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/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: true + * parameters: + * - name: id + * in: path + * description: The region's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/regions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_sales-channels.ts b/docs-util/oas-output/operations/admin/get_admin_sales-channels.ts new file mode 100644 index 0000000000..ff7900ede4 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_sales-channels.ts @@ -0,0 +1,39 @@ +/** + * @oas [get] /admin/sales-channels + * operationId: GetSalesChannels + * summary: List Sales Channels + * description: Retrieve a list of sales channels. The sales channels can be + * filtered by fields such as `id`. The sales channels can also be sorted or + * paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/sales-channels' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Sales Channels + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts b/docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts new file mode 100644 index 0000000000..f14e6a64f6 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/sales-channels/{id} + * operationId: GetSalesChannelsId + * summary: Get a Sales Channel + * description: Retrieve a sales channel by its ID. You can expand the sales + * channel's relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The sales channel's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/sales-channels/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Sales Channels + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_stores.ts b/docs-util/oas-output/operations/admin/get_admin_stores.ts new file mode 100644 index 0000000000..7c15bff3e2 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_stores.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/stores + * operationId: GetStores + * summary: List Stores + * description: Retrieve a list of stores. The stores can be filtered by fields + * such as `id`. The stores can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/stores' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Stores + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_stores_[id].ts b/docs-util/oas-output/operations/admin/get_admin_stores_[id].ts new file mode 100644 index 0000000000..be3ceb89e3 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_stores_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/stores/{id} + * operationId: GetStoresId + * summary: Get a Store + * description: Retrieve a store by its ID. You can expand the store's relations or + * select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The store's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/stores/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Stores + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_tax-rates.ts b/docs-util/oas-output/operations/admin/get_admin_tax-rates.ts new file mode 100644 index 0000000000..f156f14634 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_tax-rates.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/tax-rates + * operationId: GetTaxRates + * summary: List Tax Rates + * description: Retrieve a list of tax rates. The tax rates can be filtered by + * fields such as `id`. The tax rates can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/tax-rates' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Tax Rates + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts b/docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts new file mode 100644 index 0000000000..d5794e35e2 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/tax-rates/{id} + * operationId: GetTaxRatesId + * summary: Get a Tax Rate + * description: Retrieve a tax rate by its ID. You can expand the tax rate's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The tax rate's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/tax-rates/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Tax Rates + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_users.ts b/docs-util/oas-output/operations/admin/get_admin_users.ts new file mode 100644 index 0000000000..decde8404b --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_users.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/users + * operationId: GetUsers + * summary: List Users + * description: Retrieve a list of users. The users can be filtered by fields such + * as `id`. The users can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/users' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Users + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_users_[id].ts b/docs-util/oas-output/operations/admin/get_admin_users_[id].ts new file mode 100644 index 0000000000..e3d87feed8 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_users_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/users/{id} + * operationId: GetUsersId + * summary: Get a User + * description: Retrieve a user by its ID. You can expand the user's relations or + * select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The user's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/users/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Users + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_users_me.ts b/docs-util/oas-output/operations/admin/get_admin_users_me.ts new file mode 100644 index 0000000000..a180166250 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_users_me.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/users/me + * operationId: GetUsersMe + * summary: List Users + * description: Retrieve a list of users. The users can be filtered by fields such + * as `id`. The users can also be sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/users/me' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Users + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts new file mode 100644 index 0000000000..b41dbcf364 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts @@ -0,0 +1,39 @@ +/** + * @oas [get] /admin/workflows-executions + * operationId: GetWorkflowsExecutions + * summary: List Workflows Executions + * description: Retrieve a list of workflows executions. The workflows executions + * can be filtered by fields such as `id`. The workflows executions can also be + * sorted or paginated. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/workflows-executions' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Workflows Executions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts new file mode 100644 index 0000000000..edcfccf1b8 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /admin/workflows-executions/{id} + * operationId: GetWorkflowsExecutionsId + * summary: Get a Workflows Execution + * description: Retrieve a workflows execution by its ID. You can expand the + * workflows execution's relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The workflows execution's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/workflows-executions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Workflows Executions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts new file mode 100644 index 0000000000..7108de1f86 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts @@ -0,0 +1,53 @@ +/** + * @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id} + * operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id + * summary: "List " + * description: Retrieve a list of in a workflows execution. The can be filtered + * by fields like FILTER FIELDS. The can also be paginated. + * x-authenticated: true + * parameters: + * - name: workflow_id + * in: path + * description: The workflows execution's workflow id. + * required: true + * schema: + * type: string + * - name: transaction_id + * in: path + * description: The workflows execution's transaction id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl + * '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Workflows Executions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts new file mode 100644 index 0000000000..e2cc68e69d --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts @@ -0,0 +1,60 @@ +/** + * @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe + * operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe + * summary: List Subscribes + * description: Retrieve a list of subscribes in a workflows execution. The + * subscribes can be filtered by fields like FILTER FIELDS. The subscribes can + * also be paginated. + * x-authenticated: true + * parameters: + * - name: workflow_id + * in: path + * description: The workflows execution's workflow id. + * required: true + * schema: + * type: string + * - name: transaction_id + * in: path + * description: The workflows execution's transaction id. + * required: true + * schema: + * type: string + * - name: step_id + * in: path + * description: The workflows execution's step id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl + * '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Workflows Executions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts new file mode 100644 index 0000000000..87d877a65c --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts @@ -0,0 +1,45 @@ +/** + * @oas [get] /admin/workflows-executions/{workflow_id}/subscribe + * operationId: GetWorkflowsExecutionsWorkflow_idSubscribe + * summary: List Subscribes + * description: Retrieve a list of subscribes in a workflows execution. The + * subscribes can be filtered by fields like FILTER FIELDS. The subscribes can + * also be paginated. + * x-authenticated: true + * parameters: + * - name: workflow_id + * in: path + * description: The workflows execution's workflow id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/workflows-executions/{workflow_id}/subscribe' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Workflows Executions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_api-keys.ts b/docs-util/oas-output/operations/admin/post_admin_api-keys.ts new file mode 100644 index 0000000000..6db16d16d0 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_api-keys.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/api-keys + * operationId: PostApiKeys + * summary: Create Api Key + * description: Create a api key. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/api-keys' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Api Keys + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts new file mode 100644 index 0000000000..6074246090 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/api-keys/{id} + * operationId: PostApiKeysId + * summary: Update a Api Key + * description: Update a api key's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The api key's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/api-keys/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Api Keys + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts new file mode 100644 index 0000000000..d2d48cc70a --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/api-keys/{id}/revoke + * operationId: PostApiKeysIdRevoke + * summary: Add Revokes to Api Key + * description: Add a list of revokes to a api key. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The api key's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/api-keys/{id}/revoke' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Api Keys + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_campaigns.ts b/docs-util/oas-output/operations/admin/post_admin_campaigns.ts new file mode 100644 index 0000000000..069f30fbe2 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_campaigns.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/campaigns + * operationId: PostCampaigns + * summary: Create Campaign + * description: Create a campaign. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/campaigns' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Campaigns + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts b/docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts new file mode 100644 index 0000000000..f416e2976a --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -0,0 +1,52 @@ +/** + * @oas [post] /admin/campaigns/{id} + * operationId: PostCampaignsId + * summary: Update a Campaign + * description: Update a campaign's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The campaign's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostCampaignsReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/campaigns/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Moriah" + * }' + * tags: + * - Campaigns + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_collections.ts b/docs-util/oas-output/operations/admin/post_admin_collections.ts new file mode 100644 index 0000000000..667340250d --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_collections.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/collections + * operationId: PostCollections + * summary: Create Collection + * description: Create a collection. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/collections' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_collections_[id].ts b/docs-util/oas-output/operations/admin/post_admin_collections_[id].ts new file mode 100644 index 0000000000..a3e986eff4 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_collections_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/collections/{id} + * operationId: PostCollectionsId + * summary: Update a Collection + * description: Update a collection's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The collection's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/collections/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_customer-groups.ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups.ts new file mode 100644 index 0000000000..df6a4f82df --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customer-groups.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/customer-groups + * operationId: PostCustomerGroups + * summary: Create Customer Group + * description: Create a customer group. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customer-groups' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Customer Groups + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts new file mode 100644 index 0000000000..633d14aef3 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/customer-groups/{id} + * operationId: PostCustomerGroupsId + * summary: Update a Customer Group + * description: Update a customer group's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer group's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customer-groups/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Customer Groups + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_batch.ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_batch.ts new file mode 100644 index 0000000000..c960b8d4a2 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_batch.ts @@ -0,0 +1,56 @@ +/** + * @oas [post] /admin/customer-groups/{id}/customers/batch + * operationId: PostCustomerGroupsIdCustomersBatch + * summary: Add Customers to Customer Group + * description: Add a list of customers to a customer group. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer group's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/batch' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "customer_ids": [ + * { + * "id": "id_dx2Wieq4uGG" + * } + * ] + * }' + * tags: + * - Customer Groups + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_remove.ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_remove.ts new file mode 100644 index 0000000000..050a1f1acd --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_remove.ts @@ -0,0 +1,56 @@ +/** + * @oas [post] /admin/customer-groups/{id}/customers/remove + * operationId: PostCustomerGroupsIdCustomersRemove + * summary: Add Removes to Customer Group + * description: Add a list of removes to a customer group. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer group's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/remove' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "customer_ids": [ + * { + * "id": "id_oAhMZi39hsjIOqPA6" + * } + * ] + * }' + * tags: + * - Customer Groups + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_customers.ts b/docs-util/oas-output/operations/admin/post_admin_customers.ts new file mode 100644 index 0000000000..0abe9ae3f2 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customers.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/customers + * operationId: PostCustomers + * summary: Create Customer + * description: Create a customer. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customers' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_customers_[id].ts b/docs-util/oas-output/operations/admin/post_admin_customers_[id].ts new file mode 100644 index 0000000000..daa6e88efa --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customers_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/customers/{id} + * operationId: PostCustomersId + * summary: Update a Customer + * description: Update a customer's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customers/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts new file mode 100644 index 0000000000..b6b8994091 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/customers/{id}/addresses + * operationId: PostCustomersIdAddresses + * summary: Add Addresses to Customer + * description: Add a list of addresses to a customer. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customers/{id}/addresses' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts new file mode 100644 index 0000000000..0d3af83ac1 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -0,0 +1,49 @@ +/** + * @oas [post] /admin/customers/{id}/addresses/{address_id} + * operationId: PostCustomersIdAddressesAddress_id + * summary: Add Addresses to Customer + * description: Add a list of addresses to a customer. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer's ID. + * required: true + * schema: + * type: string + * - name: address_id + * in: path + * description: The customer's address id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_add.ts new file mode 100644 index 0000000000..efc4b0b811 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_add.ts @@ -0,0 +1,60 @@ +/** + * @oas [post] /admin/fulfillment/shipping-options/{id}/rules/batch/add + * operationId: PostFulfillmentShippingOptionsIdRulesBatchAdd + * summary: Add Adds to Fulfillment + * description: Add a list of adds to a fulfillment. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/add' \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "rules": [ + * { + * "attribute": "{value}" + * } + * ] + * }' + * tags: + * - Fulfillment + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_remove.ts new file mode 100644 index 0000000000..49b87d705d --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_remove.ts @@ -0,0 +1,60 @@ +/** + * @oas [post] /admin/fulfillment/shipping-options/{id}/rules/batch/remove + * operationId: PostFulfillmentShippingOptionsIdRulesBatchRemove + * summary: Add Removes to Fulfillment + * description: Add a list of removes to a fulfillment. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemove\ + * Req" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/remove' + * \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "rule_ids": [ + * "{value}" + * ] + * }' + * tags: + * - Fulfillment + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_inventory-items.ts b/docs-util/oas-output/operations/admin/post_admin_inventory-items.ts new file mode 100644 index 0000000000..9d08e40997 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_inventory-items.ts @@ -0,0 +1,42 @@ +/** + * @oas [post] /admin/inventory-items + * operationId: PostInventoryItems + * summary: Create Inventory Item + * description: Create a inventory item. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostInventoryItemsReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/inventory-items' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Inventory Items + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts new file mode 100644 index 0000000000..9678a2ca5c --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts @@ -0,0 +1,53 @@ +/** + * @oas [post] /admin/inventory-items/{id}/location-levels + * operationId: PostInventoryItemsIdLocationLevels + * summary: Add Location Levels to Inventory Item + * description: Add a list of location levels to a inventory item. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The inventory item's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "location_id": "{value}", + * "stocked_quantity": 1506469662949376 + * }' + * tags: + * - Inventory Items + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_invites.ts b/docs-util/oas-output/operations/admin/post_admin_invites.ts new file mode 100644 index 0000000000..e44f4d6d51 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_invites.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/invites + * operationId: PostInvites + * summary: Create Invite + * description: Create a invite. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/invites' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Invites + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts b/docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts new file mode 100644 index 0000000000..928f6a4e7a --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/invites/{id}/resend + * operationId: PostInvitesIdResend + * summary: Add Resends to Invite + * description: Add a list of resends to a invite. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The invite's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/invites/{id}/resend' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Invites + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_invites_accept.ts b/docs-util/oas-output/operations/admin/post_admin_invites_accept.ts new file mode 100644 index 0000000000..5a8ae8fb78 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_invites_accept.ts @@ -0,0 +1,47 @@ +/** + * @oas [post] /admin/invites/accept + * operationId: PostInvitesAccept + * summary: Create Invite + * description: Create a invite. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostInvitesInviteAcceptReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/invites/accept' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "first_name": "{value}", + * "last_name": "{value}" + * }' + * tags: + * - Invites + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts b/docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts new file mode 100644 index 0000000000..b6ed9e6a27 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts @@ -0,0 +1,48 @@ +/** + * @oas [post] /admin/payments/{id}/capture + * operationId: PostPaymentsIdCapture + * summary: Add Captures to Payment + * description: Add a list of captures to a payment. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The payment's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPaymentsCapturesReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/payments/{id}/capture' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Payments + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts b/docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts new file mode 100644 index 0000000000..a47ad5352a --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts @@ -0,0 +1,48 @@ +/** + * @oas [post] /admin/payments/{id}/refund + * operationId: PostPaymentsIdRefund + * summary: Add Refunds to Payment + * description: Add a list of refunds to a payment. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The payment's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPaymentsRefundsReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/payments/{id}/refund' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Payments + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_price-lists.ts b/docs-util/oas-output/operations/admin/post_admin_price-lists.ts new file mode 100644 index 0000000000..6a4dc00e9d --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_price-lists.ts @@ -0,0 +1,54 @@ +/** + * @oas [post] /admin/price-lists + * operationId: PostPriceLists + * summary: Create Price List + * description: Create a price list. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPriceListsReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/price-lists' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "title": "{value}", + * "description": "{value}", + * "prices": [ + * { + * "currency_code": "{value}", + * "amount": 1270314195484672, + * "variant_id": "{value}" + * } + * ] + * }' + * tags: + * - Price Lists + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts new file mode 100644 index 0000000000..2168dbfa70 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts @@ -0,0 +1,58 @@ +/** + * @oas [post] /admin/price-lists/{id} + * operationId: PostPriceListsId + * summary: Update a Price List + * description: Update a price list's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The price list's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPriceListsPriceListReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/price-lists/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "prices": [ + * { + * "currency_code": "{value}", + * "amount": 1670236243755008, + * "variant_id": "{value}" + * } + * ] + * }' + * tags: + * - Price Lists + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_add.ts new file mode 100644 index 0000000000..1117afd29c --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_add.ts @@ -0,0 +1,58 @@ +/** + * @oas [post] /admin/price-lists/{id}/prices/batch/add + * operationId: PostPriceListsIdPricesBatchAdd + * summary: Add Adds to Price List + * description: Add a list of adds to a price list. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The price list's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/add' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "prices": [ + * { + * "currency_code": "{value}", + * "amount": 6595965345595392, + * "variant_id": "{value}" + * } + * ] + * }' + * tags: + * - Price Lists + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_remove.ts new file mode 100644 index 0000000000..770ba4b426 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_remove.ts @@ -0,0 +1,54 @@ +/** + * @oas [post] /admin/price-lists/{id}/prices/batch/remove + * operationId: PostPriceListsIdPricesBatchRemove + * summary: Add Removes to Price List + * description: Add a list of removes to a price list. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The price list's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/remove' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "ids": [ + * "{value}" + * ] + * }' + * tags: + * - Price Lists + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts b/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts new file mode 100644 index 0000000000..f84332d6d1 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts @@ -0,0 +1,48 @@ +/** + * @oas [post] /admin/pricing/rule-types + * operationId: PostPricingRuleTypes + * summary: Create Pricing + * description: Create a pricing. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPricingRuleTypesReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/pricing/rule-types' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Thurman", + * "rule_attribute": "{value}", + * "default_priority": 4640267816665088 + * }' + * tags: + * - Pricing + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts b/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts new file mode 100644 index 0000000000..6f28b3a64e --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts @@ -0,0 +1,48 @@ +/** + * @oas [post] /admin/pricing/rule-types/{id} + * operationId: PostPricingRuleTypesId + * summary: Add Rule Types to Pricing + * description: Add a list of rule types to a pricing. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The pricing's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPricingRuleTypesRuleTypeReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/pricing/rule-types/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Pricing + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_products.ts b/docs-util/oas-output/operations/admin/post_admin_products.ts new file mode 100644 index 0000000000..9a4c663630 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_products.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/products + * operationId: PostProducts + * summary: Create Product + * description: Create a product. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id].ts b/docs-util/oas-output/operations/admin/post_admin_products_[id].ts new file mode 100644 index 0000000000..7448597464 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/products/{id} + * operationId: PostProductsId + * summary: Update a Product + * description: Update a product's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_options.ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_options.ts new file mode 100644 index 0000000000..bb870986b9 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_options.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/products/{id}/options + * operationId: PostProductsIdOptions + * summary: Add Options to Product + * description: Add a list of options to a product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}/options' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts new file mode 100644 index 0000000000..7a109b5516 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts @@ -0,0 +1,49 @@ +/** + * @oas [post] /admin/products/{id}/options/{option_id} + * operationId: PostProductsIdOptionsOption_id + * summary: Add Options to Product + * description: Add a list of options to a product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: option_id + * in: path + * description: The product's option id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}/options/{option_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants.ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants.ts new file mode 100644 index 0000000000..dafcd8c308 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/products/{id}/variants + * operationId: PostProductsIdVariants + * summary: Add Variants to Product + * description: Add a list of variants to a product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}/variants' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts new file mode 100644 index 0000000000..3bd76ecf14 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts @@ -0,0 +1,49 @@ +/** + * @oas [post] /admin/products/{id}/variants/{variant_id} + * operationId: PostProductsIdVariantsVariant_id + * summary: Add Variants to Product + * description: Add a list of variants to a product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: variant_id + * in: path + * description: The product's variant id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions.ts b/docs-util/oas-output/operations/admin/post_admin_promotions.ts new file mode 100644 index 0000000000..9724fb29f5 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/promotions + * operationId: PostPromotions + * summary: Create Promotion + * description: Create a promotion. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id].ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id].ts new file mode 100644 index 0000000000..6968f1129c --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id].ts @@ -0,0 +1,48 @@ +/** + * @oas [post] /admin/promotions/{id} + * operationId: PostPromotionsId + * summary: Update a Promotion + * description: Update a promotion's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPromotionsPromotionReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_add.ts new file mode 100644 index 0000000000..df5b45c2ad --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_add.ts @@ -0,0 +1,59 @@ +/** + * @oas [post] /admin/promotions/{id}/buy-rules/batch/add + * operationId: PostPromotionsIdBuyRulesBatchAdd + * summary: Add Adds to Promotion + * description: Add a list of adds to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch/add' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "rules": [ + * { + * "attribute": "{value}", + * "values": [ + * "{value}" + * ] + * } + * ] + * }' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_remove.ts new file mode 100644 index 0000000000..ed768117ef --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_remove.ts @@ -0,0 +1,58 @@ +/** + * @oas [post] /admin/promotions/{id}/buy-rules/batch/remove + * operationId: PostPromotionsIdBuyRulesBatchRemove + * summary: Add Removes to Promotion + * description: Add a list of removes to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch/remove' + * \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "rule_ids": [ + * "{value}" + * ] + * }' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_add.ts new file mode 100644 index 0000000000..df676868ab --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_add.ts @@ -0,0 +1,59 @@ +/** + * @oas [post] /admin/promotions/{id}/rules/batch/add + * operationId: PostPromotionsIdRulesBatchAdd + * summary: Add Adds to Promotion + * description: Add a list of adds to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/add' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "rules": [ + * { + * "attribute": "{value}", + * "values": [ + * "{value}" + * ] + * } + * ] + * }' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_remove.ts new file mode 100644 index 0000000000..1b4cc47934 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_remove.ts @@ -0,0 +1,54 @@ +/** + * @oas [post] /admin/promotions/{id}/rules/batch/remove + * operationId: PostPromotionsIdRulesBatchRemove + * summary: Add Removes to Promotion + * description: Add a list of removes to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/remove' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "rule_ids": [ + * "{value}" + * ] + * }' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_update.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_update.ts new file mode 100644 index 0000000000..7fb6010730 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_update.ts @@ -0,0 +1,60 @@ +/** + * @oas [post] /admin/promotions/{id}/rules/batch/update + * operationId: PostPromotionsIdRulesBatchUpdate + * summary: Add Updates to Promotion + * description: Add a list of updates to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/update' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "rules": [ + * { + * "id": "id_orjnxCxIQlJAp4", + * "attribute": "{value}", + * "values": [ + * "{value}" + * ] + * } + * ] + * }' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_add.ts new file mode 100644 index 0000000000..fe08fa756c --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_add.ts @@ -0,0 +1,63 @@ +/** + * @oas [post] /admin/promotions/{id}/target-rules/batch/add + * operationId: PostPromotionsIdTargetRulesBatchAdd + * summary: Add Adds to Promotion + * description: Add a list of adds to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch/add' + * \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "rules": [ + * { + * "attribute": "{value}", + * "values": [ + * "{value}" + * ] + * } + * ] + * }' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_remove.ts new file mode 100644 index 0000000000..462fc0c7b9 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_remove.ts @@ -0,0 +1,58 @@ +/** + * @oas [post] /admin/promotions/{id}/target-rules/batch/remove + * operationId: PostPromotionsIdTargetRulesBatchRemove + * summary: Add Removes to Promotion + * description: Add a list of removes to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/promotions/{id}/target-rules/batch/remove' \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "rule_ids": [ + * "{value}" + * ] + * }' + * tags: + * - Promotions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_regions.ts b/docs-util/oas-output/operations/admin/post_admin_regions.ts new file mode 100644 index 0000000000..bdd3411999 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_regions.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/regions + * operationId: PostRegions + * summary: Create Region + * description: Create a region. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/regions' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_regions_[id].ts b/docs-util/oas-output/operations/admin/post_admin_regions_[id].ts new file mode 100644 index 0000000000..eb3e7bbe85 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_regions_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/regions/{id} + * operationId: PostRegionsId + * summary: Update a Region + * description: Update a region's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The region's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/regions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_sales-channels.ts b/docs-util/oas-output/operations/admin/post_admin_sales-channels.ts new file mode 100644 index 0000000000..57858c3aa5 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_sales-channels.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/sales-channels + * operationId: PostSalesChannels + * summary: Create Sales Channel + * description: Create a sales channel. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/sales-channels' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Sales Channels + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id].ts b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id].ts new file mode 100644 index 0000000000..078e2fb265 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/sales-channels/{id} + * operationId: PostSalesChannelsId + * summary: Update a Sales Channel + * description: Update a sales channel's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The sales channel's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/sales-channels/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Sales Channels + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products_batch_add.ts new file mode 100644 index 0000000000..dfbd095c6e --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products_batch_add.ts @@ -0,0 +1,45 @@ +/** + * @oas [post] /admin/sales-channels/{id}/products/batch/add + * operationId: PostSalesChannelsIdProductsBatchAdd + * summary: Add Adds to Sales Channel + * description: Add a list of adds to a sales channel. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The sales channel's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/sales-channels/{id}/products/batch/add' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Sales Channels + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_stores_[id].ts b/docs-util/oas-output/operations/admin/post_admin_stores_[id].ts new file mode 100644 index 0000000000..d0f7c5301b --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_stores_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/stores/{id} + * operationId: PostStoresId + * summary: Update a Store + * description: Update a store's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The store's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/stores/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Stores + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_tax-rates.ts b/docs-util/oas-output/operations/admin/post_admin_tax-rates.ts new file mode 100644 index 0000000000..09d8e9ab5c --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_tax-rates.ts @@ -0,0 +1,47 @@ +/** + * @oas [post] /admin/tax-rates + * operationId: PostTaxRates + * summary: Create Tax Rate + * description: Create a tax rate. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostTaxRatesReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/tax-rates' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Emilio", + * "tax_region_id": "{value}" + * }' + * tags: + * - Tax Rates + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id].ts b/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id].ts new file mode 100644 index 0000000000..1a0d1dc6a1 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id].ts @@ -0,0 +1,48 @@ +/** + * @oas [post] /admin/tax-rates/{id} + * operationId: PostTaxRatesId + * summary: Update a Tax Rate + * description: Update a tax rate's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The tax rate's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostTaxRatesTaxRateReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/tax-rates/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Tax Rates + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts b/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts new file mode 100644 index 0000000000..6c5f4e2f17 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts @@ -0,0 +1,53 @@ +/** + * @oas [post] /admin/tax-rates/{id}/rules + * operationId: PostTaxRatesIdRules + * summary: Add Rules to Tax Rate + * description: Add a list of rules to a tax rate. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The tax rate's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostTaxRatesTaxRateRulesReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/tax-rates/{id}/rules' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "reference": "{value}", + * "reference_id": "{value}" + * }' + * tags: + * - Tax Rates + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_tax-regions.ts b/docs-util/oas-output/operations/admin/post_admin_tax-regions.ts new file mode 100644 index 0000000000..bbc3a8ceb5 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_tax-regions.ts @@ -0,0 +1,46 @@ +/** + * @oas [post] /admin/tax-regions + * operationId: PostTaxRegions + * summary: Create Tax Region + * description: Create a tax region. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostTaxRegionsReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/tax-regions' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "country_code": "{value}" + * }' + * tags: + * - Tax Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_users.ts b/docs-util/oas-output/operations/admin/post_admin_users.ts new file mode 100644 index 0000000000..d112227aa3 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_users.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/users + * operationId: PostUsers + * summary: Create User + * description: Create a user. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/users' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Users + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_users_[id].ts b/docs-util/oas-output/operations/admin/post_admin_users_[id].ts new file mode 100644 index 0000000000..f10e16fb97 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_users_[id].ts @@ -0,0 +1,52 @@ +/** + * @oas [post] /admin/users/{id} + * operationId: PostUsersId + * summary: Update a User + * description: Update a user's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The user's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUpdateUserRequest" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/users/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "avatar_url": "{value}" + * }' + * tags: + * - Users + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts new file mode 100644 index 0000000000..c4097b7bb7 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts @@ -0,0 +1,50 @@ +/** + * @oas [post] /admin/workflows-executions/{workflow_id}/run + * operationId: PostWorkflowsExecutionsWorkflow_idRun + * summary: Add Runs to Workflows Execution + * description: Add a list of runs to a workflows execution. + * x-authenticated: true + * parameters: + * - name: workflow_id + * in: path + * description: The workflows execution's workflow id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostWorkflowsRunReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/run' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Workflows Executions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts new file mode 100644 index 0000000000..70906ff777 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts @@ -0,0 +1,57 @@ +/** + * @oas [post] /admin/workflows-executions/{workflow_id}/steps/failure + * operationId: PostWorkflowsExecutionsWorkflow_idStepsFailure + * summary: Add Failures to Workflows Execution + * description: Add a list of failures to a workflows execution. + * x-authenticated: true + * parameters: + * - name: workflow_id + * in: path + * description: The workflows execution's workflow id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostWorkflowsAsyncResponseReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/workflows-executions/{workflow_id}/steps/failure' \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "transaction_id": "{value}", + * "step_id": "{value}" + * }' + * tags: + * - Workflows Executions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts new file mode 100644 index 0000000000..7171c04908 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts @@ -0,0 +1,57 @@ +/** + * @oas [post] /admin/workflows-executions/{workflow_id}/steps/success + * operationId: PostWorkflowsExecutionsWorkflow_idStepsSuccess + * summary: Add Successes to Workflows Execution + * description: Add a list of successes to a workflows execution. + * x-authenticated: true + * parameters: + * - name: workflow_id + * in: path + * description: The workflows execution's workflow id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostWorkflowsAsyncResponseReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/workflows-executions/{workflow_id}/steps/success' \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "transaction_id": "{value}", + * "step_id": "{value}" + * }' + * tags: + * - Workflows Executions + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/auth/get_auth_[scope]_[authProvider].ts b/docs-util/oas-output/operations/auth/get_auth_[scope]_[authProvider].ts new file mode 100644 index 0000000000..7ca9eb62d1 --- /dev/null +++ b/docs-util/oas-output/operations/auth/get_auth_[scope]_[authProvider].ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /auth/{scope}/{authProvider} + * operationId: GetScopeAuthprovider + * summary: "List " + * description: Retrieve a list of in a [scope]. The can be filtered by fields + * like FILTER FIELDS. The can also be paginated. + * x-authenticated: false + * parameters: + * - name: scope + * in: path + * description: The [scope]'s scope. + * required: true + * schema: + * type: string + * - name: authProvider + * in: path + * description: The [scope]'s authprovider. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/auth/{scope}/{authProvider}' + * tags: + * - "[scope]" + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/auth/get_auth_[scope]_[authProvider]_callback.ts b/docs-util/oas-output/operations/auth/get_auth_[scope]_[authProvider]_callback.ts new file mode 100644 index 0000000000..581ddb1aa4 --- /dev/null +++ b/docs-util/oas-output/operations/auth/get_auth_[scope]_[authProvider]_callback.ts @@ -0,0 +1,44 @@ +/** + * @oas [get] /auth/{scope}/{authProvider}/callback + * operationId: GetScopeAuthproviderCallback + * summary: List Callbacks + * description: Retrieve a list of callbacks in a [scope]. The callbacks can be + * filtered by fields like FILTER FIELDS. The callbacks can also be paginated. + * x-authenticated: false + * parameters: + * - name: scope + * in: path + * description: The [scope]'s scope. + * required: true + * schema: + * type: string + * - name: authProvider + * in: path + * description: The [scope]'s authprovider. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/auth/{scope}/{authProvider}/callback' + * tags: + * - "[scope]" + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/auth/post_auth_[scope]_[authProvider].ts b/docs-util/oas-output/operations/auth/post_auth_[scope]_[authProvider].ts new file mode 100644 index 0000000000..544a5abb9e --- /dev/null +++ b/docs-util/oas-output/operations/auth/post_auth_[scope]_[authProvider].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /auth/{scope}/{authProvider} + * operationId: PostScopeAuthprovider + * summary: Add to [scope] + * description: Add a list of to a [scope]. + * x-authenticated: false + * parameters: + * - name: scope + * in: path + * description: The [scope]'s scope. + * required: true + * schema: + * type: string + * - name: authProvider + * in: path + * description: The [scope]'s authprovider. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/auth/{scope}/{authProvider}' + * tags: + * - "[scope]" + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/auth/post_auth_[scope]_[authProvider]_callback.ts b/docs-util/oas-output/operations/auth/post_auth_[scope]_[authProvider]_callback.ts new file mode 100644 index 0000000000..88e12042bf --- /dev/null +++ b/docs-util/oas-output/operations/auth/post_auth_[scope]_[authProvider]_callback.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /auth/{scope}/{authProvider}/callback + * operationId: PostScopeAuthproviderCallback + * summary: Add Callbacks to [scope] + * description: Add a list of callbacks to a [scope]. + * x-authenticated: false + * parameters: + * - name: scope + * in: path + * description: The [scope]'s scope. + * required: true + * schema: + * type: string + * - name: authProvider + * in: path + * description: The [scope]'s authprovider. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/auth/{scope}/{authProvider}/callback' + * tags: + * - "[scope]" + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/auth/post_auth_session.ts b/docs-util/oas-output/operations/auth/post_auth_session.ts new file mode 100644 index 0000000000..47d272d967 --- /dev/null +++ b/docs-util/oas-output/operations/auth/post_auth_session.ts @@ -0,0 +1,31 @@ +/** + * @oas [post] /auth/session + * operationId: PostSession + * summary: Create Session + * description: Create a session. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/auth/session' + * tags: + * - Session + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/hooks/post_hooks_payment_[provider].ts b/docs-util/oas-output/operations/hooks/post_hooks_payment_[provider].ts new file mode 100644 index 0000000000..ee0134c83a --- /dev/null +++ b/docs-util/oas-output/operations/hooks/post_hooks_payment_[provider].ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /hooks/payment/{provider} + * operationId: PostPaymentProvider + * summary: Update a Payment + * description: Update a payment's details. + * x-authenticated: false + * parameters: + * - name: provider + * in: path + * description: The payment's provider. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/hooks/payment/{provider}' + * tags: + * - Payment + * 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" + * +*/ + diff --git a/docs-util/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts b/docs-util/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts new file mode 100644 index 0000000000..a7c243a19b --- /dev/null +++ b/docs-util/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts @@ -0,0 +1,44 @@ +/** + * @oas [delete] /store/carts/{id}/line-items/{line_id} + * operationId: DeleteCartsIdLineItemsLine_id + * summary: Remove Line Items from Cart + * description: Remove a list of line items from a cart. This doesn't delete the + * Line Item, only the association between the Line Item and the cart. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * - name: line_id + * in: path + * description: The cart's line id. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X DELETE '{backend_url}/store/carts/{id}/line-items/{line_id}' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/delete_store_carts_[id]_promotions.ts b/docs-util/oas-output/operations/store/delete_store_carts_[id]_promotions.ts new file mode 100644 index 0000000000..a89a68351e --- /dev/null +++ b/docs-util/oas-output/operations/store/delete_store_carts_[id]_promotions.ts @@ -0,0 +1,38 @@ +/** + * @oas [delete] /store/carts/{id}/promotions + * operationId: DeleteCartsIdPromotions + * summary: Remove Promotions from Cart + * description: Remove a list of promotions from a cart. This doesn't delete the + * Promotion, only the association between the Promotion and the cart. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X DELETE '{backend_url}/store/carts/{id}/promotions' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts b/docs-util/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts new file mode 100644 index 0000000000..56fd299f4e --- /dev/null +++ b/docs-util/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts @@ -0,0 +1,38 @@ +/** + * @oas [delete] /store/customers/me/addresses/{address_id} + * operationId: DeleteCustomersMeAddressesAddress_id + * summary: Remove Addresses from Customer + * description: Remove a list of addresses from a customer. This doesn't delete the + * Address, only the association between the Address and the customer. + * x-authenticated: false + * parameters: + * - name: address_id + * in: path + * description: The customer's address id. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' + * tags: + * - Customers + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_carts_[id].ts b/docs-util/oas-output/operations/store/get_store_carts_[id].ts new file mode 100644 index 0000000000..cfb10d8f83 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_carts_[id].ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /store/carts/{id} + * operationId: GetCartsId + * summary: Get a Cart + * description: Retrieve a cart by its ID. You can expand the cart's relations or + * select the fields that should be returned. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/carts/{id}' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_currencies.ts b/docs-util/oas-output/operations/store/get_store_currencies.ts new file mode 100644 index 0000000000..510c686e44 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_currencies.ts @@ -0,0 +1,32 @@ +/** + * @oas [get] /store/currencies + * operationId: GetCurrencies + * summary: List Currencies + * description: Retrieve a list of currencies. The currencies can be filtered by + * fields such as `id`. The currencies can also be sorted or paginated. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/currencies' + * tags: + * - Currencies + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_currencies_[code].ts b/docs-util/oas-output/operations/store/get_store_currencies_[code].ts new file mode 100644 index 0000000000..c77da5abe5 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_currencies_[code].ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /store/currencies/{code} + * operationId: GetCurrenciesCode + * summary: Get a Currency + * description: Retrieve a currency by its ID. You can expand the currency's + * relations or select the fields that should be returned. + * x-authenticated: false + * parameters: + * - name: code + * in: path + * description: The currency's code. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/currencies/{code}' + * tags: + * - Currencies + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_customers_me.ts b/docs-util/oas-output/operations/store/get_store_customers_me.ts new file mode 100644 index 0000000000..1da84671c2 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_customers_me.ts @@ -0,0 +1,32 @@ +/** + * @oas [get] /store/customers/me + * operationId: GetCustomersMe + * summary: List Customers + * description: Retrieve a list of customers. The customers can be filtered by + * fields such as `id`. The customers can also be sorted or paginated. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/customers/me' + * tags: + * - Customers + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_customers_me_addresses.ts b/docs-util/oas-output/operations/store/get_store_customers_me_addresses.ts new file mode 100644 index 0000000000..4eed1b9bea --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -0,0 +1,32 @@ +/** + * @oas [get] /store/customers/me/addresses + * operationId: GetCustomersMeAddresses + * summary: List Customers + * description: Retrieve a list of customers. The customers can be filtered by + * fields such as `id`. The customers can also be sorted or paginated. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/customers/me/addresses' + * tags: + * - Customers + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts b/docs-util/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts new file mode 100644 index 0000000000..b285f85f59 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /store/customers/me/addresses/{address_id} + * operationId: GetCustomersMeAddressesAddress_id + * summary: List Addresses + * description: Retrieve a list of addresses in a customer. The addresses can be + * filtered by fields like FILTER FIELDS. The addresses can also be paginated. + * x-authenticated: false + * parameters: + * - name: address_id + * in: path + * description: The customer's address id. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/customers/me/addresses/{address_id}' + * tags: + * - Customers + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_regions.ts b/docs-util/oas-output/operations/store/get_store_regions.ts new file mode 100644 index 0000000000..53aec49917 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_regions.ts @@ -0,0 +1,32 @@ +/** + * @oas [get] /store/regions + * operationId: GetRegions + * summary: List Regions + * description: Retrieve a list of regions. The regions can be filtered by fields + * such as `id`. The regions can also be sorted or paginated. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/regions' + * tags: + * - Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_regions_[id].ts b/docs-util/oas-output/operations/store/get_store_regions_[id].ts new file mode 100644 index 0000000000..c9dc2ef65e --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_regions_[id].ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /store/regions/{id} + * operationId: GetRegionsId + * summary: Get a Region + * description: Retrieve a region by its ID. You can expand the region's relations + * or select the fields that should be returned. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The region's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/regions/{id}' + * tags: + * - Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_regions_[id]_payment-providers.ts b/docs-util/oas-output/operations/store/get_store_regions_[id]_payment-providers.ts new file mode 100644 index 0000000000..33af99dc5a --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_regions_[id]_payment-providers.ts @@ -0,0 +1,39 @@ +/** + * @oas [get] /store/regions/{id}/payment-providers + * operationId: GetRegionsIdPaymentProviders + * summary: List Payment Providers + * description: Retrieve a list of payment providers in a region. The payment + * providers can be filtered by fields like FILTER FIELDS. The payment providers + * can also be paginated. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The region's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/regions/{id}/payment-providers' + * tags: + * - Regions + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/get_store_shipping-options_[cart_id].ts b/docs-util/oas-output/operations/store/get_store_shipping-options_[cart_id].ts new file mode 100644 index 0000000000..8b9cd5c6e9 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_shipping-options_[cart_id].ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /store/shipping-options/{cart_id} + * operationId: GetShippingOptionsCart_id + * summary: Get a Shipping Option + * description: Retrieve a shipping option by its ID. You can expand the shipping + * option's relations or select the fields that should be returned. + * x-authenticated: false + * parameters: + * - name: cart_id + * in: path + * description: The shipping option's cart id. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/shipping-options/{cart_id}' + * tags: + * - Shipping Options + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_carts.ts b/docs-util/oas-output/operations/store/post_store_carts.ts new file mode 100644 index 0000000000..b15a93a192 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_carts.ts @@ -0,0 +1,31 @@ +/** + * @oas [post] /store/carts + * operationId: PostCarts + * summary: Create Cart + * description: Create a cart. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/carts' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id].ts b/docs-util/oas-output/operations/store/post_store_carts_[id].ts new file mode 100644 index 0000000000..09d8576a27 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_carts_[id].ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /store/carts/{id} + * operationId: PostCartsId + * summary: Update a Cart + * description: Update a cart's details. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/carts/{id}' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items.ts new file mode 100644 index 0000000000..c860054212 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /store/carts/{id}/line-items + * operationId: PostCartsIdLineItems + * summary: Add Line Items to Cart + * description: Add a list of line items to a cart. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/carts/{id}/line-items' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts new file mode 100644 index 0000000000..57022564f5 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /store/carts/{id}/line-items/{line_id} + * operationId: PostCartsIdLineItemsLine_id + * summary: Add Line Items to Cart + * description: Add a list of line items to a cart. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * - name: line_id + * in: path + * description: The cart's line id. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts new file mode 100644 index 0000000000..96dbd54698 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /store/carts/{id}/payment-collections + * operationId: PostCartsIdPaymentCollections + * summary: Add Payment Collections to Cart + * description: Add a list of payment collections to a cart. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/carts/{id}/payment-collections' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_promotions.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_promotions.ts new file mode 100644 index 0000000000..acccfb3d0a --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_promotions.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /store/carts/{id}/promotions + * operationId: PostCartsIdPromotions + * summary: Add Promotions to Cart + * description: Add a list of promotions to a cart. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/carts/{id}/promotions' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_taxes.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_taxes.ts new file mode 100644 index 0000000000..2ea0165879 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_taxes.ts @@ -0,0 +1,42 @@ +/** + * @oas [post] /store/carts/{id}/taxes + * operationId: PostCartsIdTaxes + * summary: Add Taxes to Cart + * description: Add a list of taxes to a cart. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StorePostCartsCartTaxesReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/carts/{id}/taxes' + * tags: + * - Carts + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_customers.ts b/docs-util/oas-output/operations/store/post_store_customers.ts new file mode 100644 index 0000000000..0511086086 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_customers.ts @@ -0,0 +1,31 @@ +/** + * @oas [post] /store/customers + * operationId: PostCustomers + * summary: Create Customer + * description: Create a customer. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/customers' + * tags: + * - Customers + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_customers_me_addresses.ts b/docs-util/oas-output/operations/store/post_store_customers_me_addresses.ts new file mode 100644 index 0000000000..e33dfe6730 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -0,0 +1,31 @@ +/** + * @oas [post] /store/customers/me/addresses + * operationId: PostCustomersMeAddresses + * summary: Create Customer + * description: Create a customer. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/customers/me/addresses' + * tags: + * - Customers + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/docs-util/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts new file mode 100644 index 0000000000..c9b2727484 --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /store/customers/me/addresses/{address_id} + * operationId: PostCustomersMeAddressesAddress_id + * summary: Add Addresses to Customer + * description: Add a list of addresses to a customer. + * x-authenticated: false + * parameters: + * - name: address_id + * in: path + * description: The customer's address id. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' + * tags: + * - Customers + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts b/docs-util/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts new file mode 100644 index 0000000000..f5e7fbd30d --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts @@ -0,0 +1,50 @@ +/** + * @oas [post] /store/payment-collections/{id}/payment-sessions + * operationId: PostPaymentCollectionsIdPaymentSessions + * summary: Add Payment Sessions to Payment Collection + * description: Add a list of payment sessions to a payment collection. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The payment collection's ID. + * required: true + * schema: + * type: string + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StorePostPaymentCollectionsPaymentSessionReq" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/store/payment-collections/{id}/payment-sessions' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "provider_id": "{value}" + * }' + * tags: + * - Payment Collections + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminDeletePricingRuleTypesRuleTypeReq.ts b/docs-util/oas-output/schemas/AdminDeletePricingRuleTypesRuleTypeReq.ts new file mode 100644 index 0000000000..9bff34e06f --- /dev/null +++ b/docs-util/oas-output/schemas/AdminDeletePricingRuleTypesRuleTypeReq.ts @@ -0,0 +1,9 @@ +/** + * @schema AdminDeletePricingRuleTypesRuleTypeReq + * type: object + * description: SUMMARY + * x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminGetPricingRuleTypesParams.ts b/docs-util/oas-output/schemas/AdminGetPricingRuleTypesParams.ts new file mode 100644 index 0000000000..10781e502c --- /dev/null +++ b/docs-util/oas-output/schemas/AdminGetPricingRuleTypesParams.ts @@ -0,0 +1,36 @@ +/** + * @schema AdminGetPricingRuleTypesParams + * type: object + * description: SUMMARY + * x-schemaName: AdminGetPricingRuleTypesParams + * properties: + * rule_attribute: + * type: array + * description: The pricing's rule attribute. + * items: + * type: string + * title: rule_attribute + * description: The rule attribute's details. + * expand: + * type: string + * title: expand + * description: The pricing's expand. + * fields: + * type: string + * title: fields + * description: The pricing's fields. + * offset: + * type: number + * title: offset + * description: The pricing's offset. + * limit: + * type: number + * title: limit + * description: The pricing's limit. + * order: + * type: string + * title: order + * description: The pricing's order. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminGetPricingRuleTypesRuleTypeParams.ts b/docs-util/oas-output/schemas/AdminGetPricingRuleTypesRuleTypeParams.ts new file mode 100644 index 0000000000..c7771f5345 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminGetPricingRuleTypesRuleTypeParams.ts @@ -0,0 +1,17 @@ +/** + * @schema AdminGetPricingRuleTypesRuleTypeParams + * type: object + * description: SUMMARY + * x-schemaName: AdminGetPricingRuleTypesRuleTypeParams + * properties: + * expand: + * type: string + * title: expand + * description: The pricing's expand. + * fields: + * type: string + * title: fields + * description: The pricing's fields. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminGetProductsParams.ts b/docs-util/oas-output/schemas/AdminGetProductsParams.ts new file mode 100644 index 0000000000..4854599f0e --- /dev/null +++ b/docs-util/oas-output/schemas/AdminGetProductsParams.ts @@ -0,0 +1,723 @@ +/** + * @schema AdminGetProductsParams + * type: object + * description: SUMMARY + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The product's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The product's ID. + * - type: array + * description: The product's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The product's status. + * items: {} + * title: + * type: string + * title: title + * description: The product's title. + * handle: + * type: string + * title: handle + * description: The product's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * price_list_id: + * type: array + * description: The product's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * collection_id: + * type: array + * description: The product's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The product's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The product's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The product's variants. + * properties: {} + * created_at: {} + * updated_at: {} + * deleted_at: {} + * $and: + * type: array + * description: The product's $and. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $and's status. + * items: {} + * title: + * type: string + * title: title + * description: The $and's title. + * handle: + * type: string + * title: handle + * description: The $and's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * price_list_id: + * type: array + * description: The $and's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * collection_id: + * type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $and's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $and's variants. + * properties: {} + * created_at: {} + * updated_at: {} + * deleted_at: {} + * $and: + * type: array + * description: The $and's details. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $and's status. + * items: {} + * title: + * type: string + * title: title + * description: The $and's title. + * handle: + * type: string + * title: handle + * description: The $and's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * price_list_id: + * type: array + * description: The $and's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * collection_id: + * type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $and's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $and's variants. + * properties: {} + * created_at: {} + * updated_at: {} + * deleted_at: {} + * $and: + * type: array + * description: The $and's details. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * $or: + * type: array + * description: The $and's $or. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * expand: + * type: string + * title: expand + * description: The $and's expand. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * order: + * type: string + * title: order + * description: The $and's order. + * $or: + * type: array + * description: The $and's $or. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $or's status. + * items: {} + * title: + * type: string + * title: title + * description: The $or's title. + * handle: + * type: string + * title: handle + * description: The $or's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * price_list_id: + * type: array + * description: The $or's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * collection_id: + * type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $or's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $or's variants. + * properties: {} + * created_at: {} + * updated_at: {} + * deleted_at: {} + * $and: + * type: array + * description: The $or's $and. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * $or: + * type: array + * description: The $or's details. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * expand: + * type: string + * title: expand + * description: The $or's expand. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * order: + * type: string + * title: order + * description: The $or's order. + * expand: + * type: string + * title: expand + * description: The $and's expand. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * order: + * type: string + * title: order + * description: The $and's order. + * $or: + * type: array + * description: The product's $or. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $or's status. + * items: {} + * title: + * type: string + * title: title + * description: The $or's title. + * handle: + * type: string + * title: handle + * description: The $or's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * price_list_id: + * type: array + * description: The $or's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * collection_id: + * type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $or's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $or's variants. + * properties: {} + * created_at: {} + * updated_at: {} + * deleted_at: {} + * $and: + * type: array + * description: The $or's $and. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $and's status. + * items: {} + * title: + * type: string + * title: title + * description: The $and's title. + * handle: + * type: string + * title: handle + * description: The $and's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * price_list_id: + * type: array + * description: The $and's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * collection_id: + * type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $and's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $and's variants. + * properties: {} + * created_at: {} + * updated_at: {} + * deleted_at: {} + * $and: + * type: array + * description: The $and's details. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * $or: + * type: array + * description: The $and's $or. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * expand: + * type: string + * title: expand + * description: The $and's expand. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * order: + * type: string + * title: order + * description: The $and's order. + * $or: + * type: array + * description: The $or's details. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $or's status. + * items: {} + * title: + * type: string + * title: title + * description: The $or's title. + * handle: + * type: string + * title: handle + * description: The $or's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * price_list_id: + * type: array + * description: The $or's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * collection_id: + * type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $or's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $or's variants. + * properties: {} + * created_at: {} + * updated_at: {} + * deleted_at: {} + * $and: + * type: array + * description: The $or's $and. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * $or: + * type: array + * description: The $or's details. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * expand: + * type: string + * title: expand + * description: The $or's expand. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * order: + * type: string + * title: order + * description: The $or's order. + * expand: + * type: string + * title: expand + * description: The $or's expand. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * order: + * type: string + * title: order + * description: The $or's order. + * expand: + * type: string + * title: expand + * description: The product's expand. + * fields: + * type: string + * title: fields + * description: The product's fields. + * offset: + * type: number + * title: offset + * description: The product's offset. + * limit: + * type: number + * title: limit + * description: The product's limit. + * order: + * type: string + * title: order + * description: The product's order. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminGetPromotionsParams.ts b/docs-util/oas-output/schemas/AdminGetPromotionsParams.ts new file mode 100644 index 0000000000..58ade2204e --- /dev/null +++ b/docs-util/oas-output/schemas/AdminGetPromotionsParams.ts @@ -0,0 +1,33 @@ +/** + * @schema AdminGetPromotionsParams + * type: object + * description: SUMMARY + * x-schemaName: AdminGetPromotionsParams + * properties: + * code: + * type: string + * title: code + * description: The promotion's code. + * expand: + * type: string + * title: expand + * description: The promotion's expand. + * fields: + * type: string + * title: fields + * description: The promotion's fields. + * offset: + * type: number + * title: offset + * description: The promotion's offset. + * limit: + * type: number + * title: limit + * description: The promotion's limit. + * order: + * type: string + * title: order + * description: The promotion's order. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostCampaignsReq.ts b/docs-util/oas-output/schemas/AdminPostCampaignsReq.ts new file mode 100644 index 0000000000..96986c0e43 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostCampaignsReq.ts @@ -0,0 +1,51 @@ +/** + * @schema AdminPostCampaignsReq + * type: object + * description: The promotion's campaign. + * x-schemaName: AdminPostCampaignsReq + * required: + * - name + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * currency: + * type: string + * title: currency + * description: The campaign's currency. + * budget: + * $ref: "#/components/schemas/CampaignBudget" + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * x-schemaName: IdObject + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.ts b/docs-util/oas-output/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.ts new file mode 100644 index 0000000000..6a2c6c5107 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.ts @@ -0,0 +1,25 @@ +/** + * @schema AdminPostCustomerGroupsGroupCustomersBatchReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq + * required: + * - customer_ids + * properties: + * customer_ids: + * type: array + * description: The customer group's customer ids. + * items: + * type: object + * description: The customer id's customer ids. + * x-schemaName: CustomerGroupsBatchCustomer + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The customer id's ID. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.ts b/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.ts new file mode 100644 index 0000000000..6760a5e015 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.ts @@ -0,0 +1,39 @@ +/** + * @schema AdminPostFulfillmentShippingOptionsRulesBatchAddReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq + * required: + * - rules + * properties: + * rules: + * type: array + * description: The fulfillment's rules. + * items: + * type: object + * description: The rule's rules. + * x-schemaName: FulfillmentRuleCreate + * required: + * - operator + * - attribute + * - value + * properties: + * operator: {} + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * value: + * oneOf: + * - type: string + * title: value + * description: The rule's value. + * - type: array + * description: The rule's value. + * items: + * type: string + * title: value + * description: The value's details. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.ts b/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.ts new file mode 100644 index 0000000000..479af57502 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.ts @@ -0,0 +1,18 @@ +/** + * @schema AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq + * required: + * - rule_ids + * properties: + * rule_ids: + * type: array + * description: The fulfillment's rule ids. + * items: + * type: string + * title: rule_ids + * description: The rule id's rule ids. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsReq.ts b/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsReq.ts new file mode 100644 index 0000000000..9664db8855 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsReq.ts @@ -0,0 +1,24 @@ +/** + * @schema AdminPostInventoryItemsItemLocationLevelsReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq + * required: + * - location_id + * - stocked_quantity + * properties: + * location_id: + * type: string + * title: location_id + * description: The inventory item's location id. + * stocked_quantity: + * type: number + * title: stocked_quantity + * description: The inventory item's stocked quantity. + * incoming_quantity: + * type: number + * title: incoming_quantity + * description: The inventory item's incoming quantity. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostInventoryItemsReq.ts b/docs-util/oas-output/schemas/AdminPostInventoryItemsReq.ts new file mode 100644 index 0000000000..ce37692937 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostInventoryItemsReq.ts @@ -0,0 +1,61 @@ +/** + * @schema AdminPostInventoryItemsReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostInventoryItemsReq + * properties: + * sku: + * type: string + * title: sku + * description: The inventory item's sku. + * hs_code: + * type: string + * title: hs_code + * description: The inventory item's hs code. + * weight: + * type: number + * title: weight + * description: The inventory item's weight. + * length: + * type: number + * title: length + * description: The inventory item's length. + * height: + * type: number + * title: height + * description: The inventory item's height. + * width: + * type: number + * title: width + * description: The inventory item's width. + * origin_country: + * type: string + * title: origin_country + * description: The inventory item's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The inventory item's mid code. + * material: + * type: string + * title: material + * description: The inventory item's material. + * title: + * type: string + * title: title + * description: The inventory item's title. + * description: + * type: string + * title: description + * description: The inventory item's description. + * thumbnail: + * type: string + * title: thumbnail + * description: The inventory item's thumbnail. + * metadata: + * type: object + * description: The inventory item's metadata. + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostInvitesInviteAcceptReq.ts b/docs-util/oas-output/schemas/AdminPostInvitesInviteAcceptReq.ts new file mode 100644 index 0000000000..9387513090 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostInvitesInviteAcceptReq.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminPostInvitesInviteAcceptReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostInvitesInviteAcceptReq + * required: + * - first_name + * - last_name + * properties: + * first_name: + * type: string + * title: first_name + * description: The invite's first name. + * last_name: + * type: string + * title: last_name + * description: The invite's last name. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPaymentsCapturesReq.ts b/docs-util/oas-output/schemas/AdminPostPaymentsCapturesReq.ts new file mode 100644 index 0000000000..f1e704fd60 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPaymentsCapturesReq.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminPostPaymentsCapturesReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPaymentsCapturesReq + * properties: + * amount: + * type: number + * title: amount + * description: The payment's amount. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPaymentsRefundsReq.ts b/docs-util/oas-output/schemas/AdminPostPaymentsRefundsReq.ts new file mode 100644 index 0000000000..8e19d73f50 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPaymentsRefundsReq.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminPostPaymentsRefundsReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPaymentsRefundsReq + * properties: + * amount: + * type: number + * title: amount + * description: The payment's amount. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.ts b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.ts new file mode 100644 index 0000000000..1fc8a41f09 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.ts @@ -0,0 +1,47 @@ +/** + * @schema AdminPostPriceListsPriceListPricesBatchAddReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq + * required: + * - prices + * properties: + * prices: + * type: array + * description: The price list's prices. + * items: + * type: object + * description: The price's prices. + * x-schemaName: AdminPriceListPricesCreateReq + * required: + * - currency_code + * - amount + * - variant_id + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * variant_id: + * type: string + * title: variant_id + * description: The price's variant id. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * rules: + * type: object + * description: The price's rules. + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.ts b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.ts new file mode 100644 index 0000000000..fc96d81635 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.ts @@ -0,0 +1,18 @@ +/** + * @schema AdminPostPriceListsPriceListPricesBatchRemoveReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq + * required: + * - ids + * properties: + * ids: + * type: array + * description: The price list's ids. + * items: + * type: string + * title: ids + * description: The id's ids. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListReq.ts b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListReq.ts new file mode 100644 index 0000000000..99b5ee7d42 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListReq.ts @@ -0,0 +1,69 @@ +/** + * @schema AdminPostPriceListsPriceListReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPriceListsPriceListReq + * required: + * - prices + * properties: + * title: + * type: string + * title: title + * description: The price list's title. + * description: + * type: string + * title: description + * description: The price list's description. + * starts_at: + * type: string + * title: starts_at + * description: The price list's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The price list's ends at. + * status: {} + * type: {} + * prices: + * type: array + * description: The price list's prices. + * items: + * type: object + * description: The price's prices. + * x-schemaName: AdminPriceListPricesCreateReq + * required: + * - currency_code + * - amount + * - variant_id + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * variant_id: + * type: string + * title: variant_id + * description: The price's variant id. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * rules: + * type: object + * description: The price's rules. + * properties: {} + * rules: + * type: object + * description: The price list's rules. + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPriceListsReq.ts b/docs-util/oas-output/schemas/AdminPostPriceListsReq.ts new file mode 100644 index 0000000000..c15224aaf4 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPriceListsReq.ts @@ -0,0 +1,72 @@ +/** + * @schema AdminPostPriceListsReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPriceListsReq + * required: + * - title + * - description + * - type + * - prices + * properties: + * title: + * type: string + * title: title + * description: The price list's title. + * description: + * type: string + * title: description + * description: The price list's description. + * starts_at: + * type: string + * title: starts_at + * description: The price list's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The price list's ends at. + * status: {} + * type: {} + * prices: + * type: array + * description: The price list's prices. + * items: + * type: object + * description: The price's prices. + * x-schemaName: AdminPriceListPricesCreateReq + * required: + * - currency_code + * - amount + * - variant_id + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * variant_id: + * type: string + * title: variant_id + * description: The price's variant id. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * rules: + * type: object + * description: The price's rules. + * properties: {} + * rules: + * type: object + * description: The price list's rules. + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPricingRuleTypesReq.ts b/docs-util/oas-output/schemas/AdminPostPricingRuleTypesReq.ts new file mode 100644 index 0000000000..dcda3979a0 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPricingRuleTypesReq.ts @@ -0,0 +1,25 @@ +/** + * @schema AdminPostPricingRuleTypesReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPricingRuleTypesReq + * required: + * - name + * - rule_attribute + * - default_priority + * properties: + * name: + * type: string + * title: name + * description: The pricing's name. + * rule_attribute: + * type: string + * title: rule_attribute + * description: The pricing's rule attribute. + * default_priority: + * type: number + * title: default_priority + * description: The pricing's default priority. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPricingRuleTypesRuleTypeReq.ts b/docs-util/oas-output/schemas/AdminPostPricingRuleTypesRuleTypeReq.ts new file mode 100644 index 0000000000..c3c41f6311 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPricingRuleTypesRuleTypeReq.ts @@ -0,0 +1,21 @@ +/** + * @schema AdminPostPricingRuleTypesRuleTypeReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPricingRuleTypesRuleTypeReq + * properties: + * name: + * type: string + * title: name + * description: The pricing's name. + * rule_attribute: + * type: string + * title: rule_attribute + * description: The pricing's rule attribute. + * default_priority: + * type: number + * title: default_priority + * description: The pricing's default priority. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionReq.ts b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionReq.ts new file mode 100644 index 0000000000..97439be95d --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionReq.ts @@ -0,0 +1,54 @@ +/** + * @schema AdminPostPromotionsPromotionReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPromotionsPromotionReq + * properties: + * code: + * type: string + * title: code + * description: The promotion's code. + * is_automatic: + * type: boolean + * title: is_automatic + * description: The promotion's is automatic. + * type: {} + * campaign_id: + * type: string + * title: campaign_id + * description: The promotion's campaign id. + * campaign: + * $ref: "#/components/schemas/AdminPostCampaignsReq" + * application_method: + * $ref: "#/components/schemas/ApplicationMethodsMethodPostReq" + * rules: + * type: array + * description: The promotion's rules. + * items: + * type: object + * description: The rule's rules. + * x-schemaName: PromotionRule + * required: + * - operator + * - attribute + * - values + * properties: + * operator: {} + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * values: + * type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.ts b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.ts new file mode 100644 index 0000000000..748d2baba1 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.ts @@ -0,0 +1,39 @@ +/** + * @schema AdminPostPromotionsPromotionRulesBatchAddReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq + * required: + * - rules + * properties: + * rules: + * type: array + * description: The promotion's rules. + * items: + * type: object + * description: The rule's rules. + * x-schemaName: PromotionRule + * required: + * - operator + * - attribute + * - values + * properties: + * operator: {} + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * values: + * type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.ts b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.ts new file mode 100644 index 0000000000..4543fcc384 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.ts @@ -0,0 +1,18 @@ +/** + * @schema AdminPostPromotionsPromotionRulesBatchRemoveReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq + * required: + * - rule_ids + * properties: + * rule_ids: + * type: array + * description: The promotion's rule ids. + * items: + * type: string + * title: rule_ids + * description: The rule id's rule ids. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.ts b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.ts new file mode 100644 index 0000000000..2646a25987 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.ts @@ -0,0 +1,43 @@ +/** + * @schema AdminPostPromotionsPromotionRulesBatchUpdateReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq + * required: + * - rules + * properties: + * rules: + * type: array + * description: The promotion's rules. + * items: + * type: object + * description: The rule's rules. + * x-schemaName: UpdatePromotionRule + * required: + * - id + * - attribute + * - values + * properties: + * id: + * type: string + * title: id + * description: The rule's ID. + * operator: {} + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * values: + * type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostTaxRatesReq.ts b/docs-util/oas-output/schemas/AdminPostTaxRatesReq.ts new file mode 100644 index 0000000000..342cc5b9fb --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostTaxRatesReq.ts @@ -0,0 +1,59 @@ +/** + * @schema AdminPostTaxRatesReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostTaxRatesReq + * required: + * - name + * - tax_region_id + * properties: + * rate: + * type: number + * title: rate + * description: The tax rate's rate. + * code: + * type: string + * title: code + * description: The tax rate's code. + * rules: + * type: array + * description: The tax rate's rules. + * items: + * type: object + * description: The rule's rules. + * x-schemaName: CreateTaxRateRule + * required: + * - reference + * - reference_id + * properties: + * reference: + * type: string + * title: reference + * description: The rule's reference. + * reference_id: + * type: string + * title: reference_id + * description: The rule's reference id. + * name: + * type: string + * title: name + * description: The tax rate's name. + * is_default: + * type: boolean + * title: is_default + * description: The tax rate's is default. + * is_combinable: + * type: boolean + * title: is_combinable + * description: The tax rate's is combinable. + * tax_region_id: + * type: string + * title: tax_region_id + * description: The tax rate's tax region id. + * metadata: + * type: object + * description: The tax rate's metadata. + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateReq.ts b/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateReq.ts new file mode 100644 index 0000000000..cc254ee496 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateReq.ts @@ -0,0 +1,46 @@ +/** + * @schema AdminPostTaxRatesTaxRateReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostTaxRatesTaxRateReq + * properties: + * code: + * type: string + * title: code + * description: The tax rate's code. + * name: + * type: string + * title: name + * description: The tax rate's name. + * region_id: + * type: string + * title: region_id + * description: The tax rate's region id. + * rate: + * type: number + * title: rate + * description: The tax rate's rate. + * products: + * type: array + * description: The tax rate's products. + * items: + * type: string + * title: products + * description: The product's products. + * shipping_options: + * type: array + * description: The tax rate's shipping options. + * items: + * type: string + * title: shipping_options + * description: The shipping option's shipping options. + * product_types: + * type: array + * description: The tax rate's product types. + * items: + * type: string + * title: product_types + * description: The product type's product types. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateRulesReq.ts b/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateRulesReq.ts new file mode 100644 index 0000000000..0664aa311a --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateRulesReq.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminPostTaxRatesTaxRateRulesReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostTaxRatesTaxRateRulesReq + * required: + * - reference + * - reference_id + * properties: + * reference: + * type: string + * title: reference + * description: The tax rate's reference. + * reference_id: + * type: string + * title: reference_id + * description: The tax rate's reference id. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostTaxRegionsReq.ts b/docs-util/oas-output/schemas/AdminPostTaxRegionsReq.ts new file mode 100644 index 0000000000..b00a1ceebb --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostTaxRegionsReq.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminPostTaxRegionsReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostTaxRegionsReq + * required: + * - country_code + * properties: + * country_code: + * type: string + * title: country_code + * description: The tax region's country code. + * province_code: + * type: string + * title: province_code + * description: The tax region's province code. + * parent_id: + * type: string + * title: parent_id + * description: The tax region's parent id. + * default_tax_rate: + * $ref: "#/components/schemas/CreateDefaultTaxRate" + * metadata: + * type: object + * description: The tax region's metadata. + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostWorkflowsAsyncResponseReq.ts b/docs-util/oas-output/schemas/AdminPostWorkflowsAsyncResponseReq.ts new file mode 100644 index 0000000000..5abe22ecc2 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostWorkflowsAsyncResponseReq.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminPostWorkflowsAsyncResponseReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostWorkflowsAsyncResponseReq + * required: + * - transaction_id + * - step_id + * properties: + * transaction_id: + * type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * step_id: + * type: string + * title: step_id + * description: The workflows execution's step id. + * response: {} + * compensate_input: {} + * action: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminPostWorkflowsRunReq.ts b/docs-util/oas-output/schemas/AdminPostWorkflowsRunReq.ts new file mode 100644 index 0000000000..ff8ee01d5a --- /dev/null +++ b/docs-util/oas-output/schemas/AdminPostWorkflowsRunReq.ts @@ -0,0 +1,14 @@ +/** + * @schema AdminPostWorkflowsRunReq + * type: object + * description: SUMMARY + * x-schemaName: AdminPostWorkflowsRunReq + * properties: + * input: {} + * transaction_id: + * type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * +*/ + diff --git a/docs-util/oas-output/schemas/AdminUpdateUserRequest.ts b/docs-util/oas-output/schemas/AdminUpdateUserRequest.ts new file mode 100644 index 0000000000..9799b8c543 --- /dev/null +++ b/docs-util/oas-output/schemas/AdminUpdateUserRequest.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminUpdateUserRequest + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateUserRequest + * required: + * - avatar_url + * properties: + * first_name: + * type: string + * title: first_name + * description: The user's first name. + * last_name: + * type: string + * title: last_name + * description: The user's last name. + * avatar_url: + * type: string + * title: avatar_url + * description: The user's avatar url. + * +*/ + diff --git a/docs-util/oas-output/schemas/ApplicationMethodsMethodPostReq.ts b/docs-util/oas-output/schemas/ApplicationMethodsMethodPostReq.ts new file mode 100644 index 0000000000..014dddc294 --- /dev/null +++ b/docs-util/oas-output/schemas/ApplicationMethodsMethodPostReq.ts @@ -0,0 +1,88 @@ +/** + * @schema ApplicationMethodsMethodPostReq + * type: object + * description: The promotion's application method. + * x-schemaName: ApplicationMethodsMethodPostReq + * properties: + * description: + * type: string + * title: description + * description: The application method's description. + * value: + * type: string + * title: value + * description: The application method's value. + * max_quantity: + * type: number + * title: max_quantity + * description: The application method's max quantity. + * type: {} + * target_type: {} + * allocation: {} + * target_rules: + * type: array + * description: The application method's target rules. + * items: + * type: object + * description: The target rule's target rules. + * x-schemaName: PromotionRule + * required: + * - operator + * - attribute + * - values + * properties: + * operator: {} + * description: + * type: string + * title: description + * description: The target rule's description. + * attribute: + * type: string + * title: attribute + * description: The target rule's attribute. + * values: + * type: array + * description: The target rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * buy_rules: + * type: array + * description: The application method's buy rules. + * items: + * type: object + * description: The buy rule's buy rules. + * x-schemaName: PromotionRule + * required: + * - operator + * - attribute + * - values + * properties: + * operator: {} + * description: + * type: string + * title: description + * description: The buy rule's description. + * attribute: + * type: string + * title: attribute + * description: The buy rule's attribute. + * values: + * type: array + * description: The buy rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * apply_to_quantity: + * type: number + * title: apply_to_quantity + * description: The application method's apply to quantity. + * buy_rules_min_quantity: + * type: number + * title: buy_rules_min_quantity + * description: The application method's buy rules min quantity. + * +*/ + diff --git a/docs-util/oas-output/schemas/CampaignBudget.ts b/docs-util/oas-output/schemas/CampaignBudget.ts new file mode 100644 index 0000000000..0069228a43 --- /dev/null +++ b/docs-util/oas-output/schemas/CampaignBudget.ts @@ -0,0 +1,14 @@ +/** + * @schema CampaignBudget + * type: object + * description: The campaign's budget. + * x-schemaName: CampaignBudget + * properties: + * type: {} + * limit: + * type: number + * title: limit + * description: The budget's limit. + * +*/ + diff --git a/docs-util/oas-output/schemas/CreateDefaultTaxRate.ts b/docs-util/oas-output/schemas/CreateDefaultTaxRate.ts new file mode 100644 index 0000000000..80d4619f63 --- /dev/null +++ b/docs-util/oas-output/schemas/CreateDefaultTaxRate.ts @@ -0,0 +1,27 @@ +/** + * @schema CreateDefaultTaxRate + * type: object + * description: The tax region's default tax rate. + * x-schemaName: CreateDefaultTaxRate + * required: + * - name + * properties: + * rate: + * type: number + * title: rate + * description: The default tax rate's rate. + * code: + * type: string + * title: code + * description: The default tax rate's code. + * name: + * type: string + * title: name + * description: The default tax rate's name. + * metadata: + * type: object + * description: The default tax rate's metadata. + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/StorePostCartsCartTaxesReq.ts b/docs-util/oas-output/schemas/StorePostCartsCartTaxesReq.ts new file mode 100644 index 0000000000..3069349de4 --- /dev/null +++ b/docs-util/oas-output/schemas/StorePostCartsCartTaxesReq.ts @@ -0,0 +1,9 @@ +/** + * @schema StorePostCartsCartTaxesReq + * type: object + * description: SUMMARY + * x-schemaName: StorePostCartsCartTaxesReq + * properties: {} + * +*/ + diff --git a/docs-util/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts b/docs-util/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts new file mode 100644 index 0000000000..cdb50df41e --- /dev/null +++ b/docs-util/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts @@ -0,0 +1,20 @@ +/** + * @schema StorePostPaymentCollectionsPaymentSessionReq + * type: object + * description: SUMMARY + * x-schemaName: StorePostPaymentCollectionsPaymentSessionReq + * required: + * - provider_id + * properties: + * provider_id: + * type: string + * title: provider_id + * description: The payment collection's provider id. + * context: {} + * data: + * type: object + * description: The payment collection's data. + * properties: {} + * +*/ +