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

oas: [12/n] improve admin oas (#8967)

Browse Source
This commit is contained in:
Shahed Nasser
2024-09-03 17:32:58 +03:00
committed by GitHub
parent 46a70eaf5b
commit ee2c297caa
19 changed files with 264 additions and 404 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
www/utils/generated/oas-output/operations/admin/post_admin_products.ts
View File

@@ -58,12 +58,12 @@
* allOf:
* - $ref: "#/components/schemas/AdminCreateProduct"
* - type: object
* description: SUMMARY
* description: The product's details.
* properties:
* additional_data:
* type: object
* description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
* description: SUMMARY
* description: The product's details.
* x-codeSamples:
* - lang: Shell
* label: cURL

4
www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts
View File

@@ -64,12 +64,12 @@
* allOf:
* - $ref: "#/components/schemas/AdminUpdateProduct"
* - type: object
* description: SUMMARY
* description: The properties to update in a product.
* properties:
* additional_data:
* type: object
* description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
* description: SUMMARY
* description: The properties to update in a product.
* x-codeSamples:
* - lang: Shell
* label: cURL

9
www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts
View File

@@ -1,8 +1,9 @@
/**
* @oas [post] /admin/products/{id}/variants
* operationId: PostProductsIdVariants
* summary: Add Variants to Product
* description: Add a list of variants to a product.
* summary: Create a Product Variant
* x-sidebar-summary: Create Variant
* description: Create a variant for a product.
* x-authenticated: true
* parameters:
* - name: id
@@ -64,12 +65,12 @@
* allOf:
* - $ref: "#/components/schemas/AdminCreateProductVariant"
* - type: object
* description: SUMMARY
* description: The product variant's details.
* properties:
* additional_data:
* type: object
* description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
* description: SUMMARY
* description: The product variant's details.
* x-codeSamples:
* - lang: Shell
* label: cURL

9
www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts
View File

@@ -1,8 +1,9 @@
/**
* @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.
* summary: Update a Product Variant
* x-sidebar-summary: Update Variant
* description: Update a variant's details.
* x-authenticated: true
* parameters:
* - name: id
@@ -70,12 +71,12 @@
* allOf:
* - $ref: "#/components/schemas/AdminUpdateProductVariant"
* - type: object
* description: SUMMARY
* description: The properties to update in the variant.
* properties:
* additional_data:
* type: object
* description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
* description: SUMMARY
* description: The properties to update in the variant.
* x-codeSamples:
* - lang: Shell
* label: cURL

5
www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts
View File

@@ -1,8 +1,9 @@
/**
* @oas [post] /admin/products/{id}/variants/batch
* operationId: PostProductsIdVariantsBatch
* summary: Add Variants to Product
* description: Add a list of variants to a product.
* summary: Manage Variants in a Product
* x-sidebary-summary: Manage Variants
* description: Manage variants in a product to create, update, or delete them.
* x-authenticated: true
* parameters:
* - name: id

35
www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts
View File

@@ -1,8 +1,9 @@
/**
* @oas [post] /admin/products/{id}/variants/inventory-items/batch
* operationId: PostProductsIdVariantsInventoryItemsBatch
* summary: Add Inventory Items to Product
* description: Add a list of inventory items to a product.
* summary: Manage Variants Inventory in a Product
* x-sidebar-summary: Manage Variants Inventory
* description: Manage a product's variant's inventoris to associate them with inventory items, update their inventory items, or delete their association with inventory items.
* x-authenticated: true
* parameters:
* - name: id
@@ -20,14 +21,14 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The product variant inventories to manage.
* properties:
* create:
* type: array
* description: The product's create.
* description:
* items:
* type: object
* description: The create's details.
* description: The associations to create between a product variant and an inventory item.
* required:
* - required_quantity
* - inventory_item_id
@@ -36,21 +37,21 @@
* required_quantity:
* type: number
* title: required_quantity
* description: The create's required quantity.
* description: The variant's quantity.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The create's inventory item id.
* description: The ID of the inventory item to associate the variant with.
* variant_id:
* type: string
* title: variant_id
* description: The create's variant id.
* description: The ID of the variant.
* update:
* type: array
* description: The product's update.
* description: The product variants to update their association with inventory items.
* items:
* type: object
* description: The update's details.
* description: Update a product variant's association with an inventory item.
* required:
* - required_quantity
* - inventory_item_id
@@ -59,21 +60,21 @@
* required_quantity:
* type: number
* title: required_quantity
* description: The update's required quantity.
* description: The variant's quantity.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The update's inventory item id.
* description: The ID of the inventory item the variant is associated with.
* variant_id:
* type: string
* title: variant_id
* description: The update's variant id.
* description: The ID of the variant.
* delete:
* type: array
* description: The product's delete.
* description: The product variants to delete their association with inventory items.
* items:
* type: object
* description: The delete's details.
* description: Delete a product variant's association with an inventory item.
* required:
* - inventory_item_id
* - variant_id
@@ -81,11 +82,11 @@
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The delete's inventory item id.
* description: The ID of the inventory item associated with the variant.
* variant_id:
* type: string
* title: variant_id
* description: The delete's variant id.
* description: The ID of the variant.
* x-codeSamples:
* - lang: Shell
* label: cURL

4
www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts
View File

@@ -1,8 +1,8 @@
/**
* @oas [post] /admin/products/batch
* operationId: PostProductsBatch
* summary: Create Product
* description: Create a product.
* summary: Manage Products
* description: Manage products to create, update, or delete them.
* x-authenticated: true
* parameters:
* - name: expand

12
www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts
View File

@@ -1,8 +1,16 @@
/**
* @oas [post] /admin/products/export
* operationId: PostProductsExport
* summary: Create Product
* description: Create a product.
* summary: Export Products
* description: >
* Start a product export process to retrieve a CSV of exported products.
*
*
* You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the
* execution, send a GET request to `/admin/workflows-executions/export-products/:transaction-id`.
*
* Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications
* using the `/admin/notification` API route to retrieve the file's download URL.
* x-authenticated: true
* parameters:
* - name: expand

4
www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts
View File

@@ -1,8 +1,8 @@
/**
* @oas [post] /admin/products/import
* operationId: PostProductsImport
* summary: Create Product
* description: Create a product.
* summary: Create Product Import
* description: Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/import` API route.
* x-authenticated: true
* parameters: []
* security:

10
www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts
View File

@@ -1,13 +1,13 @@
/**
* @oas [post] /admin/products/import/{transaction_id}/confirm
* operationId: PostProductsImportTransaction_idConfirm
* summary: Add Confirms to Product
* description: Add a list of confirms to a product.
* summary: Confirm Product Import
* description: Confirm that a created product import should start importing the products into Medusa.
* x-authenticated: true
* parameters:
* - name: transaction_id
* in: path
* description: The product's transaction id.
* description: The ID of the transaction returned when the product import was created.
* required: true
* schema:
* type: string
@@ -36,10 +36,6 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
* x-workflow: importProductsWorkflowId
*
*/

118
www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts
View File

@@ -57,7 +57,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The promotion's details.
* required:
* - code
* - type
@@ -71,19 +71,22 @@
* is_automatic:
* type: boolean
* title: is_automatic
* description: The promotion's is automatic.
* description: Whether the promotion is applied automatically.
* type:
* type: string
* description: The promotion's type.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion
* enum:
* - standard
* - buyget
* campaign_id:
* type: string
* title: campaign_id
* description: The promotion's campaign id.
* description: The ID of the campaign that the promotion belongs to.
* campaign:
* type: object
* description: The promotion's campaign.
* description: The details of a campaign to create and add the promotion to it.
* required:
* - name
* - campaign_identifier
@@ -99,14 +102,14 @@
* campaign_identifier:
* type: string
* title: campaign_identifier
* description: The campaign's campaign identifier.
* description: The campaign's identifier.
* description:
* type: string
* title: description
* description: The campaign's description.
* budget:
* type: object
* description: The campaign's budget.
* description: The campaign's budget which, when crossed, ends the campaign.
* required:
* - type
* - limit
@@ -114,6 +117,9 @@
* properties:
* type:
* type: string
* description: >
* The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions.
* Use `usage` to set a limit on the total number of times the campaign's promotions can be used.
* enum:
* - spend
* - usage
@@ -124,30 +130,17 @@
* currency_code:
* type: string
* title: currency_code
* description: The budget's currency code.
* description: The campaign budget's currency code. This can't be edited later.
* starts_at:
* type: string
* title: starts_at
* description: The campaign's starts at.
* description: The campaign's start date.
* format: date-time
* ends_at:
* type: string
* title: ends_at
* description: The campaign's ends at.
* description: The campaign's end date.
* format: date-time
* promotions:
* type: array
* description: The campaign's promotions.
* items:
* type: object
* description: The promotion's promotions.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The promotion's ID.
* application_method:
* type: object
* description: The promotion's application method.
@@ -168,7 +161,7 @@
* value:
* type: number
* title: value
* description: The application method's value.
* description: The discounted amount applied by the associated promotion based on the `type`.
* currency_code:
* type: string
* title: currency_code
@@ -176,20 +169,23 @@
* max_quantity:
* type: number
* title: max_quantity
* description: The application method's max quantity.
* description: The max quantity allowed in the cart for the associated promotion to be applied.
* type:
* type: string
* description: The type of the application method indicating how the associated promotion is applied.
* enum:
* - fixed
* - percentage
* target_type:
* type: string
* description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order.
* enum:
* - order
* - shipping_methods
* - items
* allocation:
* type: string
* description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart.
* enum:
* - each
* - across
@@ -198,7 +194,7 @@
* description: The application method's target rules.
* items:
* type: object
* description: The target rule's target rules.
* description: A target rule's details.
* required:
* - operator
* - description
@@ -207,6 +203,7 @@
* properties:
* operator:
* type: string
* description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -222,24 +219,27 @@
* attribute:
* type: string
* title: attribute
* description: The target rule's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The target rule's values.
* - type: array
* description: The target rule's values.
* items:
* type: string
* title: values
* description: The value's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: An attribute value.
* example: prod_123
* buy_rules:
* type: array
* description: The application method's buy rules.
* items:
* type: object
* description: The buy rule's buy rules.
* description: A buy rule's details.
* required:
* - operator
* - description
@@ -248,6 +248,7 @@
* properties:
* operator:
* type: string
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -263,32 +264,35 @@
* attribute:
* type: string
* title: attribute
* description: The buy rule's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The buy rule's values.
* - type: array
* description: The buy rule's values.
* items:
* type: string
* title: values
* description: The value's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: An attribute value.
* example: prod_123
* apply_to_quantity:
* type: number
* title: apply_to_quantity
* description: The application method's apply to quantity.
* description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`.
* buy_rules_min_quantity:
* type: number
* title: buy_rules_min_quantity
* description: The application method's buy rules min quantity.
* description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`.
* rules:
* type: array
* description: The promotion's rules.
* items:
* type: object
* description: The rule's rules.
* description: A rule's details.
* required:
* - operator
* - description
@@ -297,6 +301,7 @@
* properties:
* operator:
* type: string
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -312,25 +317,28 @@
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The rule's values.
* - type: array
* description: The rule's values.
* items:
* type: string
* title: values
* description: The value's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: An attribute value.
* example: prod_123
* - type: object
* description: SUMMARY
* description: The promotion's details.
* properties:
* additional_data:
* type: object
* description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
* description: SUMMARY
* description: The promotion's details.
* x-codeSamples:
* - lang: Shell
* label: cURL

221
www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts
View File

@@ -63,7 +63,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The properties to update in a promotion.
* required:
* - campaign_id
* properties:
@@ -74,93 +74,34 @@
* is_automatic:
* type: boolean
* title: is_automatic
* description: The promotion's is automatic.
* description: Whether the promotion is applied automatically.
* type:
* type: string
* description: The promotion's type.
* externalDocs:
* url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion
* enum:
* - standard
* - buyget
* campaign_id:
* type: string
* title: campaign_id
* description: The promotion's campaign id.
* campaign:
* type: object
* description: The promotion's campaign.
* required:
* - name
* - campaign_identifier
* - description
* - budget
* - starts_at
* - ends_at
* 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.
* budget:
* type: object
* description: The campaign's budget.
* required:
* - type
* - limit
* - currency_code
* properties:
* type:
* type: string
* enum:
* - spend
* - usage
* limit:
* type: number
* title: limit
* description: The budget's limit.
* currency_code:
* type: string
* title: currency_code
* description: The budget's currency code.
* starts_at:
* type: string
* title: starts_at
* description: The campaign's starts at.
* format: date-time
* ends_at:
* type: string
* title: ends_at
* description: The campaign's ends at.
* format: date-time
* promotions:
* type: array
* description: The campaign's promotions.
* items:
* type: object
* description: The promotion's promotions.
* required:
* - id
* properties:
* id:
* type: string
* title: id
* description: The promotion's ID.
* description: The ID of the campaign that the promotion belongs to.
* application_method:
* type: object
* description: The promotion's application method.
* description: The properties to update in the application method.
* required:
* - id
* - description
* - max_quantity
* - currency_code
* - apply_to_quantity
* - buy_rules_min_quantity
* properties:
* id:
* type: string
* title: id
* description: The application method's ID.
* description:
* type: string
* title: description
@@ -168,169 +109,49 @@
* value:
* type: number
* title: value
* description: The application method's value.
* description: The discounted amount applied by the associated promotion based on the `type`.
* max_quantity:
* type: number
* title: max_quantity
* description: The application method's max quantity.
* description: The max quantity allowed in the cart for the associated promotion to be applied.
* currency_code:
* type: string
* title: currency_code
* description: The application method's currency code.
* type:
* type: string
* description: The type of the application method indicating how the associated promotion is applied.
* enum:
* - fixed
* - percentage
* target_type:
* type: string
* description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order.
* enum:
* - order
* - shipping_methods
* - items
* allocation:
* type: string
* description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart.
* enum:
* - each
* - across
* target_rules:
* type: array
* description: The application method's target rules.
* items:
* type: object
* description: The target rule's target rules.
* required:
* - operator
* - description
* - attribute
* - values
* properties:
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The target rule's description.
* attribute:
* type: string
* title: attribute
* description: The target rule's attribute.
* values:
* oneOf:
* - type: string
* title: values
* description: The target rule's 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.
* required:
* - operator
* - description
* - attribute
* - values
* properties:
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The buy rule's description.
* attribute:
* type: string
* title: attribute
* description: The buy rule's attribute.
* values:
* oneOf:
* - type: string
* title: values
* description: The buy rule's 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.
* description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`.
* buy_rules_min_quantity:
* type: number
* title: buy_rules_min_quantity
* description: The application method's buy rules min quantity.
* rules:
* type: array
* description: The promotion's rules.
* items:
* type: object
* description: The rule's rules.
* required:
* - operator
* - description
* - attribute
* - values
* properties:
* operator:
* type: string
* enum:
* - gte
* - lte
* - gt
* - lt
* - eq
* - ne
* - in
* description:
* type: string
* title: description
* description: The rule's description.
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* values:
* oneOf:
* - type: string
* title: values
* description: The rule's values.
* - type: array
* description: The rule's values.
* items:
* type: string
* title: values
* description: The value's values.
* description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`.
* - type: object
* description: SUMMARY
* description: The properties to update in a promotion.
* properties:
* additional_data:
* type: object
* description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter.
* description: SUMMARY
* description: The properties to update in a promotion.
* x-codeSamples:
* - lang: Shell
* label: cURL

66
www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts
View File

@@ -1,8 +1,9 @@
/**
* @oas [post] /admin/promotions/{id}/buy-rules/batch
* operationId: PostPromotionsIdBuyRulesBatch
* summary: Add Buy Rules to Promotion
* description: Add a list of buy rules to a promotion.
* summary: Manage the Buy Rules of a Promotion
* x-sidebar-summary: Manage Buy Rules
* description: Manage the buy rules of a `buyget` promotion to create, update, or delete them.
* x-authenticated: true
* parameters:
* - name: id
@@ -62,14 +63,14 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The buy rules to create, update, or delete.
* properties:
* create:
* type: array
* description: The promotion's create.
* description: The buy rules to create.
* items:
* type: object
* description: The create's details.
* description: A buy rule's details.
* required:
* - operator
* - description
@@ -78,6 +79,7 @@
* properties:
* operator:
* type: string
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -89,28 +91,31 @@
* description:
* type: string
* title: description
* description: The create's description.
* description: The buy rule's description.
* attribute:
* type: string
* title: attribute
* description: The create's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The create's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The create's values.
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: The value's values.
* description: An attribute value.
* example: prod_123
* update:
* type: array
* description: The promotion's update.
* description: The buy rules to update.
* items:
* type: object
* description: The update's details.
* description: The properties to update in a buy rule.
* required:
* - id
* - description
@@ -119,9 +124,10 @@
* id:
* type: string
* title: id
* description: The update's ID.
* description: The buy rule's ID.
* operator:
* type: string
* description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -133,29 +139,32 @@
* description:
* type: string
* title: description
* description: The update's description.
* description: The buy rule's description.
* attribute:
* type: string
* title: attribute
* description: The update's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The update's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The update's values.
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: The value's values.
* description: An attribute value.
* example: prod_123
* delete:
* type: array
* description: The promotion's delete.
* description: The buy rules to delete.
* items:
* type: string
* title: delete
* description: The delete's details.
* description: A buy rule's ID.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -171,7 +180,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The result of the batch operations.
* required:
* - created
* - updated
@@ -179,17 +188,17 @@
* properties:
* created:
* type: array
* description: The promotion's created.
* description: The created buy rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* updated:
* type: array
* description: The promotion's updated.
* description: The updated buy rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* deleted:
* type: object
* description: The promotion's deleted.
* description: The details of the deleted buy rules.
* required:
* - ids
* - object
@@ -197,19 +206,20 @@
* properties:
* ids:
* type: array
* description: The deleted's ids.
* description: The IDs of the buy rules that were deleted.
* items:
* type: string
* title: ids
* description: The id's ids.
* description: A buy rule's ID.
* object:
* type: string
* title: object
* description: The deleted's object.
* description: The name of the object that was deleted.
* default: "promotion-rule"
* deleted:
* type: boolean
* title: deleted
* description: The deleted's details.
* description: Whether the buy rules were deleted.
* "400":
* $ref: "#/components/responses/400_error"
* "401":

66
www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts
View File

@@ -1,8 +1,9 @@
/**
* @oas [post] /admin/promotions/{id}/rules/batch
* operationId: PostPromotionsIdRulesBatch
* summary: Add Rules to Promotion
* description: Add a list of rules to a promotion.
* summary: Manage a Promotion's Rules
* x-sidebar-summary: Manage Rules
* description: Manage the rules of a promotion to create, update, or delete them.
* x-authenticated: true
* parameters:
* - name: id
@@ -62,14 +63,14 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The rules to create, update, or delete.
* properties:
* create:
* type: array
* description: The promotion's create.
* description: The rules to create.
* items:
* type: object
* description: The create's details.
* description: A rule's details.
* required:
* - operator
* - description
@@ -78,6 +79,7 @@
* properties:
* operator:
* type: string
* description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -89,28 +91,31 @@
* description:
* type: string
* title: description
* description: The create's description.
* description: The rule's description.
* attribute:
* type: string
* title: attribute
* description: The create's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The create's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The create's values.
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: The value's values.
* description: An attribute value.
* example: prod_123
* update:
* type: array
* description: The promotion's update.
* description: The rules to update.
* items:
* type: object
* description: The update's details.
* description: The properties to update in a rule.
* required:
* - id
* - description
@@ -119,9 +124,10 @@
* id:
* type: string
* title: id
* description: The update's ID.
* description: The rule's ID.
* operator:
* type: string
* description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -133,29 +139,32 @@
* description:
* type: string
* title: description
* description: The update's description.
* description: The rule's description.
* attribute:
* type: string
* title: attribute
* description: The update's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The update's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The update's values.
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: The value's values.
* description: An attribute value.
* example: prod_123
* delete:
* type: array
* description: The promotion's delete.
* description: The rules to delete.
* items:
* type: string
* title: delete
* description: The delete's details.
* description: A rule's ID.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -171,7 +180,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The result of the batch operations.
* required:
* - created
* - updated
@@ -179,17 +188,17 @@
* properties:
* created:
* type: array
* description: The promotion's created.
* description: The created rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* updated:
* type: array
* description: The promotion's updated.
* description: The updated rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* deleted:
* type: object
* description: The promotion's deleted.
* description: The details of the deleted buy rules.
* required:
* - ids
* - object
@@ -197,19 +206,20 @@
* properties:
* ids:
* type: array
* description: The deleted's ids.
* description: The IDs of the deleted rules.
* items:
* type: string
* title: ids
* description: The id's ids.
* description: A rule's ID.
* object:
* type: string
* title: object
* description: The deleted's object.
* description: The name of the object that was deleted.
* default: "promotion-rule"
* deleted:
* type: boolean
* title: deleted
* description: The deleted's details.
* description: Whether the rules were deleted.
* "400":
* $ref: "#/components/responses/400_error"
* "401":

66
www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts
View File

@@ -1,8 +1,9 @@
/**
* @oas [post] /admin/promotions/{id}/target-rules/batch
* operationId: PostPromotionsIdTargetRulesBatch
* summary: Add Target Rules to Promotion
* description: Add a list of target rules to a promotion.
* summary: Manage Target Rules of a Promotion
* x-sidebar-summary: Manage Target Rules
* description: Manage the target rules of a promotion to create, update, or delete them.
* x-authenticated: true
* parameters:
* - name: id
@@ -62,14 +63,14 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The target rules to create, update, or delete.
* properties:
* create:
* type: array
* description: The promotion's create.
* description: The target rules to create.
* items:
* type: object
* description: The create's details.
* description: A target rule's details.
* required:
* - operator
* - description
@@ -78,6 +79,7 @@
* properties:
* operator:
* type: string
* description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -89,28 +91,31 @@
* description:
* type: string
* title: description
* description: The create's description.
* description: The target rule's description.
* attribute:
* type: string
* title: attribute
* description: The create's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The create's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The create's values.
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: The value's values.
* description: An attribute value.
* example: prod_123
* update:
* type: array
* description: The promotion's update.
* description: The target rules to update.
* items:
* type: object
* description: The update's details.
* description: The properties to update in a target rule.
* required:
* - id
* - description
@@ -119,9 +124,10 @@
* id:
* type: string
* title: id
* description: The update's ID.
* description: The target rule's ID.
* operator:
* type: string
* description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value.
* enum:
* - gte
* - lte
@@ -133,29 +139,32 @@
* description:
* type: string
* title: description
* description: The update's description.
* description: The target rule's description.
* attribute:
* type: string
* title: attribute
* description: The update's attribute.
* description: The attribute to compare against when checking whether a promotion can be applied on a cart.
* example: items.product.id
* values:
* oneOf:
* - type: string
* title: values
* description: The update's values.
* description: The attribute's value.
* example: prod_123
* - type: array
* description: The update's values.
* description: The allowed attribute values.
* items:
* type: string
* title: values
* description: The value's values.
* description: An attribute value.
* example: prod_123
* delete:
* type: array
* description: The promotion's delete.
* description: The target rules to delete.
* items:
* type: string
* title: delete
* description: The delete's details.
* description: A target rule's ID.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -171,7 +180,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The result of the batch operations.
* required:
* - created
* - updated
@@ -179,17 +188,17 @@
* properties:
* created:
* type: array
* description: The promotion's created.
* description: The created target rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* updated:
* type: array
* description: The promotion's updated.
* description: The updated target rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* deleted:
* type: object
* description: The promotion's deleted.
* description: The details of the deleted target rules.
* required:
* - ids
* - object
@@ -197,19 +206,20 @@
* properties:
* ids:
* type: array
* description: The deleted's ids.
* description: The IDs of deleted target rules.
* items:
* type: string
* title: ids
* description: The id's ids.
* description: A target rule's ID.
* object:
* type: string
* title: object
* description: The deleted's object.
* description: The name of the object that was deleted.
* default: "promotion-rule"
* deleted:
* type: boolean
* title: deleted
* description: The deleted's details.
* description: Whether the target rules were deleted.
* "400":
* $ref: "#/components/responses/400_error"
* "401":

4
www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts
View File

@@ -62,9 +62,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - description
* description: The properties to update in the refund reason.
* properties:
* label:
* type: string

16
www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts
View File

@@ -62,9 +62,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - metadata
* description: The propeties to update in the region.
* properties:
* name:
* type: string
@@ -80,25 +78,25 @@
* items:
* type: string
* title: countries
* description: The country's countries.
* description: A country code.
* automatic_taxes:
* type: boolean
* title: automatic_taxes
* description: The region's automatic taxes.
* description: Whether taxes are calculated automatically for carts in the region.
* payment_providers:
* type: array
* description: The region's payment providers.
* description: The payment providers enabled in the region.
* items:
* type: string
* title: payment_providers
* description: The payment provider's payment providers.
* description: A payment provider's ID.
* metadata:
* type: object
* description: The region's metadata.
* description: The region's metadata. Can hold custom key-value pairs.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: The region's is tax inclusive.
* description: Whether the prices in the region are tax inclusive.
* x-codeSamples:
* - lang: Shell
* label: cURL

11
www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts
View File

@@ -62,26 +62,23 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - description
* - metadata
* description: The properties to update in the reservation.
* properties:
* location_id:
* type: string
* title: location_id
* description: The reservation's location id.
* description: The ID of the associated location.
* quantity:
* type: number
* title: quantity
* description: The reservation's quantity.
* description: The reserved quantity.
* description:
* type: string
* title: description
* description: The reservation's description.
* metadata:
* type: object
* description: The reservation's metadata.
* description: The reservation's metadata. Can hold custom key-value pairs.
* x-codeSamples:
* - lang: Shell
* label: cURL

4
www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts
View File

@@ -1,8 +1,8 @@
/**
* @oas [post] /admin/returns/{id}/cancel
* operationId: PostReturnsIdCancel
* summary: Add Cancels to Return
* description: Add a list of cancels to a return.
* summary: Cancel a return.
* description: Cancel a return.
* x-authenticated: true
* parameters:
* - name: id