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

oas: [6/n] Improve admin OAS (#8901)

Browse Source
This commit is contained in:
Shahed Nasser
2024-09-02 09:39:27 +03:00
committed by GitHub
parent 1f2ee24e1d
commit ba653692e1
20 changed files with 3331 additions and 5134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5321
www/utils/generated/oas-output/operations/admin/get_admin_products.ts
View File

File diff suppressed because it is too large Load Diff

55
www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts
View File

@@ -1,8 +1,9 @@
/**
* @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.
* summary: List a Product's Options
* x-sidebar-summary: List Options
* description: Retrieve a list of options of a product. The options can be filtered by fields like `id`. The options can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
@@ -55,12 +56,12 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The product's q.
* description: Search term to filter the product option's searchable fields.
* required: false
* schema:
* type: string
* title: q
* description: The product's q.
* description: Search term to filter the product option's searchable fields.
* - name: id
* in: query
* required: false
@@ -68,13 +69,13 @@
* oneOf:
* - type: string
* title: id
* description: The product's ID.
* description: Filter by the product option's ID.
* - type: array
* description: The product's ID.
* description: Filter by product option IDs.
* items:
* type: string
* title: id
* description: The id's ID.
* description: A product option's ID.
* - name: title
* in: query
* required: false
@@ -82,44 +83,30 @@
* oneOf:
* - type: string
* title: title
* description: The product's title.
* description: Filter by a title.
* - type: array
* description: The product's title.
* description: Filter by titles.
* items:
* type: string
* title: title
* description: The title's details.
* - name: product_id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: product_id
* description: The product's product id.
* - type: array
* description: The product's product id.
* items:
* type: string
* title: product_id
* description: The product id's details.
* description: An option's title.
* - name: $and
* in: query
* description: The product's $and.
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: The product's $and.
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* description: The product's $or.
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: The product's $or.
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
@@ -143,7 +130,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of product options.
* required:
* - limit
* - offset
@@ -152,23 +139,23 @@
* limit:
* type: number
* title: limit
* description: The product's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The product's offset.
* description: The number of items skipped before the returned items.
* count:
* type: number
* title: count
* description: The product's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of product options.
* required:
* - product_options
* properties:
* product_options:
* type: array
* description: The product's product options.
* description: The list of product options.
* items:
* $ref: "#/components/schemas/AdminProductOption"
* "400":

5
www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts
View File

@@ -1,8 +1,9 @@
/**
* @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.
* summary: Get a Product's Option
* x-sidebar-summary: Get Option
* description: Retrieve a product's option by its ID.
* x-authenticated: true
* parameters:
* - name: id

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

@@ -1,7 +1,8 @@
/**
* @oas [get] /admin/products/{id}/variants
* operationId: GetProductsIdVariants
* summary: List Variants
* summary: List Variants of a Product
* x-sidebar-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:
@@ -53,6 +54,421 @@
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: Search term to filter the variant's search attributes.
* required: false
* schema:
* type: string
* title: q
* description: Search term to filter the variant's search attributes.
* - name: id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: id
* description: Filter by a variant's ID.
* - type: array
* description: Filter by variant IDs.
* items:
* type: string
* title: id
* description: A variant ID.
* - name: manage_inventory
* in: query
* description: Filter by whether a variant's `manage_inventory` property is enabled.
* required: false
* schema:
* type: boolean
* title: manage_inventory
* description: Filter by whether a variant's `manage_inventory` property is enabled.
* - name: allow_backorder
* in: query
* description: Filter by whether backorders are allowed for the variant.
* required: false
* schema:
* type: boolean
* title: allow_backorder
* description: Filter by whether backorders are allowed for the variant.
* - name: created_at
* in: query
* description: Filter by the product's creation date.
* required: false
* schema:
* type: object
* description: Filter by the product's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: Filter by the product's update date.
* required: false
* schema:
* type: object
* description: Filter by the product's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: Filter by the product's deletion date.
* required: false
* schema:
* type: object
* description: Filter by the product's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []
@@ -73,7 +489,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of product variants.
* required:
* - limit
* - offset
@@ -82,23 +498,23 @@
* limit:
* type: number
* title: limit
* description: The product's limit.
* description: The maximum number of returned items.
* offset:
* type: number
* title: offset
* description: The product's offset.
* description: The number of items skipped before the returned item.
* count:
* type: number
* title: count
* description: The product's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of product variants.
* required:
* - variants
* properties:
* variants:
* type: array
* description: The product's variants.
* description: The list of product variants.
* items:
* $ref: "#/components/schemas/AdminProductVariant"
* "400":

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

@@ -1,8 +1,9 @@
/**
* @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.
* summary: Get Variant of a Product
* x-sidebar-summary: Get Variant
* description: Retrieve a product's variant by its ID.
* x-authenticated: true
* parameters:
* - name: id
@@ -13,7 +14,7 @@
* type: string
* - name: variant_id
* in: path
* description: The product's variant id.
* description: The variant's ID.
* required: true
* schema:
* type: string

396
www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts
View File

@@ -49,12 +49,12 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The promotion's q.
* description: Search term to filter the promotion's searchable attributes.
* required: false
* schema:
* type: string
* title: q
* description: The promotion's q.
* description: Search term to filter the promotion's searchable attributes.
* - name: code
* in: query
* required: false
@@ -62,13 +62,13 @@
* oneOf:
* - type: string
* title: code
* description: The promotion's code.
* description: Filter by a promotion code.
* - type: array
* description: The promotion's code.
* description: Filter by promotion codes.
* items:
* type: string
* title: code
* description: The code's details.
* description: A promotion code.
* - name: campaign_id
* in: query
* required: false
@@ -76,53 +76,395 @@
* oneOf:
* - type: string
* title: campaign_id
* description: The promotion's campaign id.
* description: Filter by a campaign's ID to retrieve its associated promotions.
* - type: array
* description: The promotion's campaign id.
* description: Filter by campaign IDs to retrieve their associated promotions.
* items:
* type: string
* title: campaign_id
* description: The campaign id's details.
* description: A campaign's ID.
* - name: application_method
* in: query
* description: The promotion's application method.
* description: Apply filters on the application methods to retrieve the promotions of the matching application methods.
* required: false
* schema:
* type: object
* description: The promotion's application method.
* description: Apply filters on the application methods to retrieve the promotions of the matching application methods.
* properties:
* currency_code:
* oneOf:
* - type: string
* title: currency_code
* description: The application method's currency code.
* description: Filter by a currency code.
* - type: array
* description: The application method's currency code.
* description: Filter by currency codes.
* items:
* type: string
* title: currency_code
* description: The currency code's details.
* description: A currency code.
* - name: created_at
* in: query
* description: The promotion's created at.
* description: Filter by a promotion's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a promotion's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The promotion's updated at.
* description: Filter by a promotion's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a promotion's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The promotion's deleted at.
* description: Filter by a promotion's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a promotion's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: $and
* in: query
* required: false
* schema:
* type: array
* description: The promotion's $and.
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
@@ -131,7 +473,7 @@
* required: false
* schema:
* type: array
* description: The promotion's $or.
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
@@ -155,7 +497,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of promotions.
* required:
* - limit
* - offset
@@ -164,23 +506,23 @@
* limit:
* type: number
* title: limit
* description: The promotion's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The promotion's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The promotion's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of promotions.
* required:
* - promotions
* properties:
* promotions:
* type: array
* description: The promotion's promotions.
* description: The list of promotions.
* items:
* $ref: "#/components/schemas/AdminPromotion"
* "400":

42
www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts
View File

@@ -1,8 +1,14 @@
/**
* @oas [get] /admin/promotions/{id}/{rule_type}
* operationId: GetPromotionsIdRule_type
* summary: "List "
* description: Retrieve a list of in a promotion. The can be filtered by fields like FILTER FIELDS. The can also be paginated.
* summary: List Rules of a Promotion
* x-sidebar-summary: List Rules
* description: >
* Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter:
*
* - If `rule_type` is `rules`, the promotion's rules are retrivied.
* - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved.
* - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved.
* x-authenticated: true
* parameters:
* - name: id
@@ -13,10 +19,14 @@
* type: string
* - name: rule_type
* in: path
* description: The promotion's rule type.
* description: The type of rules to retrieve.
* required: true
* schema:
* type: string
* enum:
* - rules
* - target-rules
* - buy-rules
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
@@ -59,6 +69,28 @@
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: promotion_type
* in: query
* description: The type of promotion to retrieve its rules. This is only used if the promotion doesn't have a type.
* required: false
* schema:
* type: string
* title: promotion_type
* description: The type of promotion to retrieve its rules. This is only used if the promotion doesn't have a type.
* enum:
* - standard
* - buyget
* - name: application_method_type
* in: query
* description: The type of application method to retrieve its rules. This is only used if the promotion doesn't have an application method, or its method doesn't have a type.
* required: false
* schema:
* type: string
* title: application_method_type
* description: The type of application method to retrieve its rules. This is only used if the promotion doesn't have an application method, or its method doesn't have a type.
* enum:
* - fixed
* - percentage
* security:
* - api_token: []
* - cookie_auth: []
@@ -78,13 +110,13 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The list of promotion rules.
* required:
* - rules
* properties:
* rules:
* type: array
* description: The promotion's rules.
* description: The list of promotion rules.
* items:
* $ref: "#/components/schemas/AdminPromotionRule"
* "400":

36
www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts
View File

@@ -1,32 +1,50 @@
/**
* @oas [get] /admin/promotions/rule-attribute-options/{rule_type}
* operationId: GetPromotionsRuleAttributeOptionsRule_type
* summary: List Rule Attribute Options
* description: Retrieve a list of rule attribute options in a promotion. The rule attribute options can be filtered by fields like FILTER FIELDS. The rule attribute options can also be paginated.
* summary: List Rule Attribute Options of a Rule Type
* x-sidebar-summary: List Rule Attribute Options
* description: >
* Retrieve a list of attributes for the promotion and application method types specified in the query parameters.
*
* Only the attributes of the rule type specified in the path parameter are retrieved:
*
* - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved.
* - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved.
* - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved.
* x-authenticated: true
* parameters:
* - name: rule_type
* in: path
* description: The promotion's rule type.
* description: The rule type.
* required: true
* schema:
* type: string
* enum:
* - rules
* - target-rules
* - buy-rules
* - name: promotion_type
* in: query
* description: The promotion's promotion type.
* description: The promotion type to retrieve rules for.
* required: false
* schema:
* type: string
* title: promotion_type
* description: The promotion's promotion type.
* description: The promotion type to retrieve rules for.
* enum:
* - standard
* - buyget
* - name: application_method_type
* in: query
* description: The promotion's application method type.
* description: The application method type to retrieve rules for.
* required: false
* schema:
* type: string
* title: application_method_type
* description: The promotion's application method type.
* description: The application method type to retrieve rules for.
* enum:
* - fixed
* - percentage
* security:
* - api_token: []
* - cookie_auth: []
@@ -46,13 +64,13 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The list of attributes.
* required:
* - attributes
* properties:
* attributes:
* type: array
* description: The promotion's attributes.
* description: The list of attributes.
* items:
* $ref: "#/components/schemas/AdminRuleAttributeOption"
* "400":

35
www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts
View File

@@ -1,19 +1,28 @@
/**
* @oas [get] /admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}
* operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id
* summary: "List "
* description: Retrieve a list of in a promotion. The can be filtered by fields like FILTER FIELDS. The can also be paginated.
* summary: List Rule Values Given a Rule Attribute
* x-sidebar-summary: List Rule Values
* description: >
* Retrieve all potential values for promotion rules and target and buy rules based on the specified rule attribute and type.
*
* For example, if you provide the ID of the `currency_code` rule attribute, and set `rule_type` to `rules`, a list of currencies
* are retrieved in label-value pairs.
* x-authenticated: true
* parameters:
* - name: rule_type
* in: path
* description: The promotion's rule type.
* description: The rule type.
* required: true
* schema:
* type: string
* enum:
* - rules
* - target-rules
* - buy-rules
* - name: rule_attribute_id
* in: path
* description: The promotion's rule attribute id.
* description: The rule attribute's ID.
* required: true
* schema:
* type: string
@@ -61,20 +70,26 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: promotion_type
* in: query
* description: The promotion's promotion type.
* description: The promotion type to retrieve rules for.
* required: false
* schema:
* type: string
* title: promotion_type
* description: The promotion's promotion type.
* description: The promotion type to retrieve rules for.
* enum:
* - standard
* - buyget
* - name: application_method_type
* in: query
* description: The promotion's application method type.
* description: The application method type to retrieve rules for.
* required: false
* schema:
* type: string
* title: application_method_type
* description: The promotion's application method type.
* description: The application method type to retrieve rules for.
* enum:
* - fixed
* - percentage
* security:
* - api_token: []
* - cookie_auth: []
@@ -94,13 +109,13 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The list of rule values.
* required:
* - values
* properties:
* values:
* type: array
* description: The promotion's values.
* description: The list of rule values.
* items:
* $ref: "#/components/schemas/AdminRuleValueOption"
* "400":

42
www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts
View File

@@ -47,6 +47,48 @@
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: id
* description: Filter by a refund reason's ID.
* - type: array
* description: Filter by refund reason IDs.
* items:
* type: string
* title: id
* description: A refund reason ID.
* - name: q
* in: query
* description: Search term to filter the refund reason's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: Search term to filter the refund reason's searchable properties.
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []

392
www/utils/generated/oas-output/operations/admin/get_admin_regions.ts
View File

@@ -49,12 +49,12 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The region's q.
* description: Search term to filter the region's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The region's q.
* description: Search term to filter the region's searchable properties.
* - name: id
* in: query
* required: false
@@ -62,13 +62,13 @@
* oneOf:
* - type: string
* title: id
* description: The region's ID.
* description: Filter by a region's ID.
* - type: array
* description: The region's ID.
* description: Filter by region IDs.
* items:
* type: string
* title: id
* description: The id's ID.
* description: A region's ID.
* - name: code
* in: query
* required: false
@@ -76,13 +76,13 @@
* oneOf:
* - type: string
* title: code
* description: The region's code.
* description: Filter by a currency code.
* - type: array
* description: The region's code.
* description: Filter by currency codes.
* items:
* type: string
* title: code
* description: The code's details.
* description: A currency code.
* - name: name
* in: query
* required: false
@@ -90,34 +90,376 @@
* oneOf:
* - type: string
* title: name
* description: The region's name.
* description: Filter by a region's name.
* - type: array
* description: The region's name.
* description: Filter by region names.
* items:
* type: string
* title: name
* description: The name's details.
* description: A region's name.
* - name: created_at
* in: query
* description: The region's created at.
* description: Filter by a region's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a region's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The region's updated at.
* description: Filter by a region's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a region's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The region's deleted at.
* description: Filter by a region's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a region's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: $and
* in: query
* required: false
* schema:
* type: array
* description: The region's $and.
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
@@ -126,7 +468,7 @@
* required: false
* schema:
* type: array
* description: The region's $or.
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
@@ -150,7 +492,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of regions.
* required:
* - limit
* - offset
@@ -159,23 +501,23 @@
* limit:
* type: number
* title: limit
* description: The region's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The region's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The region's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of regions.
* required:
* - regions
* properties:
* regions:
* type: array
* description: The region's regions.
* description: The list of regions.
* items:
* $ref: "#/components/schemas/AdminRegion"
* "400":

530
www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts
View File

@@ -54,13 +54,13 @@
* oneOf:
* - type: string
* title: location_id
* description: The reservation's location id.
* description: Filter by a location's ID to retrieve its associated reservations.
* - type: array
* description: The reservation's location id.
* description: Filter by location IDs to retrieve its associated reservations.
* items:
* type: string
* title: location_id
* description: The location id's details.
* description: A location ID.
* - name: inventory_item_id
* in: query
* required: false
@@ -68,13 +68,13 @@
* oneOf:
* - type: string
* title: inventory_item_id
* description: The reservation's inventory item id.
* description: Filter by an inventory item's ID to retrieve its associated reservations.
* - type: array
* description: The reservation's inventory item id.
* description: Filter by inventory item IDs to retrieve its associated reservations.
* items:
* type: string
* title: inventory_item_id
* description: The inventory item id's details.
* description: An inventory item ID
* - name: line_item_id
* in: query
* required: false
@@ -82,13 +82,13 @@
* oneOf:
* - type: string
* title: line_item_id
* description: The reservation's line item id.
* description: Filter by a line item's ID to retrieve its associated reservations.
* - type: array
* description: The reservation's line item id.
* description: Filter by line item IDs to retrieve its associated reservations.
* items:
* type: string
* title: line_item_id
* description: The line item id's details.
* description: A line item ID
* - name: created_by
* in: query
* required: false
@@ -96,13 +96,13 @@
* oneOf:
* - type: string
* title: created_by
* description: The reservation's created by.
* description: Filter by the ID of a user to retrieve the reservations they created.
* - type: array
* description: The reservation's created by.
* description: Filter by user IDs to retrieve the reservations they created.
* items:
* type: string
* title: created_by
* description: The created by's details.
* description: A user's ID.
* - name: description
* in: query
* required: false
@@ -110,82 +110,458 @@
* oneOf:
* - type: string
* title: description
* description: The reservation's description.
* description: Filter by a reservation's description. This filter applies a full-text match. To search by keywords, use the `q` query parameter instead.
* - type: object
* description: The reservation's description.
* required:
* - $eq
* - $ne
* - $in
* - $nin
* - $like
* - $ilike
* - $re
* - $contains
* - $gt
* - $gte
* - $lt
* - $lte
* description: Apply filters on the reservation's description.
* properties:
* $eq: {}
* $ne: {}
* $in: {}
* $nin: {}
* $like: {}
* $ilike: {}
* $re: {}
* $contains: {}
* $gt: {}
* $gte: {}
* $lt: {}
* $lte: {}
* $eq:
* type: string
* description: Filter by an exact match.
* $ne:
* type: string
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array's items.
* items:
* type: string
* $nin:
* type: array
* description: Filter by values not in this array's items.
* items:
* type: string
* $like:
* type: string
* description: Apply a `like` filter. Useful for strings only.
* $ilike:
* type: string
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $re:
* type: string
* description: Apply a regex filter. Useful for strings only.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* $gt:
* type: string
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* - name: quantity
* in: query
* description: The reservation's quantity.
* description: Filter by a reserved quantity.
* required: false
* schema:
* description: The reservation's quantity.
* required:
* - $eq
* - $ne
* - $in
* - $nin
* - $like
* - $ilike
* - $re
* - $contains
* - $gt
* - $gte
* - $lt
* - $lte
* properties:
* $eq: {}
* $ne: {}
* $in: {}
* $nin: {}
* $like: {}
* $ilike: {}
* $re: {}
* $contains: {}
* $gt: {}
* $gte: {}
* $lt: {}
* $lte: {}
* $eq:
* type: string
* description: Filter by an exact match.
* $ne:
* type: string
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array's items.
* items:
* type: string
* $nin:
* type: array
* description: Filter by values not in this array's items.
* items:
* type: string
* $like:
* type: string
* description: Apply a `like` filter. Useful for strings only.
* $ilike:
* type: string
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $re:
* type: string
* description: Apply a regex filter. Useful for strings only.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* $gt:
* type: string
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* - name: created_at
* in: query
* description: The reservation's created at.
* description: Filter by a reservation's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a reservation's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The reservation's updated at.
* description: Filter by a reservation's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a reservation's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The reservation's deleted at.
* description: Filter by a reservation's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a reservation's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []
@@ -206,7 +582,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of reservations.
* required:
* - limit
* - offset
@@ -215,23 +591,23 @@
* limit:
* type: number
* title: limit
* description: The reservation's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The reservation's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The reservation's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of reservations.
* required:
* - reservations
* properties:
* reservations:
* type: array
* description: The reservation's reservations.
* description: The list of reservations`.
* items:
* $ref: "#/components/schemas/ReservationResponse"
* "400":

396
www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts
View File

@@ -49,12 +49,12 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The return reason's q.
* description: Search term to filter the return reason's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The return reason's q.
* description: Search term to filter the return reason's searchable properties.
* - name: id
* in: query
* required: false
@@ -62,13 +62,13 @@
* oneOf:
* - type: string
* title: id
* description: The return reason's ID.
* description: Filter by a return reason ID.
* - type: array
* description: The return reason's ID.
* description: Filter by return reason IDs.
* items:
* type: string
* title: id
* description: The id's ID.
* description: A return reason ID.
* - name: value
* in: query
* required: false
@@ -76,13 +76,13 @@
* oneOf:
* - type: string
* title: value
* description: The return reason's value.
* description: Filter by a return reason's value.
* - type: array
* description: The return reason's value.
* description: Filter by return reason values.
* items:
* type: string
* title: value
* description: The value's details.
* description: A return reason value.
* - name: label
* in: query
* required: false
@@ -90,13 +90,13 @@
* oneOf:
* - type: string
* title: label
* description: The return reason's label.
* description: Filter by a return reason's label.
* - type: array
* description: The return reason's label.
* description: Filter by return reason labels.
* items:
* type: string
* title: label
* description: The label's details.
* description: A return reason label.
* - name: description
* in: query
* required: false
@@ -104,13 +104,13 @@
* oneOf:
* - type: string
* title: description
* description: The return reason's description.
* description: Filter by a description. This filter looks for an exact match of the return reason's description. To search by a term or keywords, use the `q` query parameter instead.
* - type: array
* description: The return reason's description.
* description: Filter by descriptions. This filter looks for an exact match of the return reason's description. To search by a term or keywords, use the `q` query parameter instead.
* items:
* type: string
* title: description
* description: The description's details.
* description: A return reason's description.
* - name: parent_return_reason_id
* in: query
* required: false
@@ -118,45 +118,387 @@
* oneOf:
* - type: string
* title: parent_return_reason_id
* description: The return reason's parent return reason id.
* description: Filter by a return reason's ID to retrieve its child return reasons.
* - type: array
* description: The return reason's parent return reason id.
* description: Filter by return reason IDs to retrieve their child return reasons.
* items:
* type: string
* title: parent_return_reason_id
* description: The parent return reason id's details.
* description: The return reason's ID.
* - name: created_at
* in: query
* description: The return reason's created at.
* description: Filter by a return reason's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a return reason's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The return reason's updated at.
* description: Filter by a return reason's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a return reason's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The return reason's deleted at.
* description: Filter by a return reason's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a return reason's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: $and
* in: query
* description: The return reason's $and.
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: The return reason's $and.
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* description: The return reason's $or.
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: The return reason's $or.
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or

48
www/utils/generated/oas-output/operations/admin/get_admin_returns.ts
View File

@@ -47,6 +47,54 @@
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: id
* description: Filter by a return's ID.
* - type: array
* description: Filter by return IDs.
* items:
* type: string
* title: id
* description: A return ID.
* - name: status
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: status
* description: Filter by a return status.
* - type: array
* description: Filter by return statuses.
* items:
* type: string
* title: status
* description: A return status.
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* required: false
* schema:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* security:
* - api_token: []
* - cookie_auth: []

19
www/utils/generated/oas-output/schemas/AdminCreateRefundReason.ts Normal file
View File

@@ -0,0 +1,19 @@
/**
* @schema AdminCreateRefundReason
* type: object
* description: SUMMARY
* required:
* - label
* properties:
* label:
* type: string
* title: label
* description: The refund reason's label.
* description:
* type: string
* title: description
* description: The refund reason's description.
* x-schemaName: AdminCreateRefundReason
*
*/

17
www/utils/generated/oas-output/schemas/AdminGetPromotionRuleParams.ts Normal file
View File

@@ -0,0 +1,17 @@
/**
* @schema AdminGetPromotionRuleParams
* type: object
* description: SUMMARY
* x-schemaName: AdminGetPromotionRuleParams
* properties:
* promotion_type:
* type: string
* title: promotion_type
* description: The promotion's promotion type.
* application_method_type:
* type: string
* title: application_method_type
* description: The promotion's application method type.
*
*/

59
www/utils/generated/oas-output/schemas/AdminOrderFilters.ts Normal file
View File

@@ -0,0 +1,59 @@
/**
* @schema AdminOrderFilters
* type: object
* description: SUMMARY
* x-schemaName: AdminOrderFilters
* properties:
* id:
* oneOf:
* - type: string
* title: id
* description: The return's ID.
* - type: array
* description: The return's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* name:
* oneOf:
* - type: string
* title: name
* description: The return's name.
* - type: array
* description: The return's name.
* items:
* type: string
* title: name
* description: The name's details.
* limit:
* type: number
* title: limit
* description: The return's limit.
* offset:
* type: number
* title: offset
* description: The return's offset.
* order:
* type: string
* title: order
* description: The return's order.
* fields:
* type: string
* title: fields
* description: The return's fields.
* $and:
* type: array
* description: The return's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The return's $or.
* items:
* type: object
* title: $or
*
*/

364
www/utils/generated/oas-output/schemas/OrderLineItem.ts Normal file
View File

@@ -0,0 +1,364 @@
/**
* @schema OrderLineItem
* type: object
* description: The item's items.
* x-schemaName: OrderLineItem
* required:
* - id
* - title
* - requires_shipping
* - is_discountable
* - is_tax_inclusive
* - unit_price
* - raw_unit_price
* - quantity
* - raw_quantity
* - detail
* - created_at
* - updated_at
* - original_total
* - original_subtotal
* - original_tax_total
* - item_total
* - item_subtotal
* - item_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - refundable_total
* - refundable_total_per_unit
* - raw_original_total
* - raw_original_subtotal
* - raw_original_tax_total
* - raw_item_total
* - raw_item_subtotal
* - raw_item_tax_total
* - raw_total
* - raw_subtotal
* - raw_tax_total
* - raw_discount_total
* - raw_discount_tax_total
* - raw_refundable_total
* - raw_refundable_total_per_unit
* properties:
* id:
* type: string
* title: id
* description: The item's ID.
* title:
* type: string
* title: title
* description: The item's title.
* subtitle:
* type: string
* title: subtitle
* description: The item's subtitle.
* thumbnail:
* type: string
* title: thumbnail
* description: The item's thumbnail.
* variant_id:
* type: string
* title: variant_id
* description: The item's variant id.
* product_id:
* type: string
* title: product_id
* description: The item's product id.
* product_title:
* type: string
* title: product_title
* description: The item's product title.
* product_description:
* type: string
* title: product_description
* description: The item's product description.
* product_subtitle:
* type: string
* title: product_subtitle
* description: The item's product subtitle.
* product_type:
* type: string
* title: product_type
* description: The item's product type.
* product_collection:
* type: string
* title: product_collection
* description: The item's product collection.
* product_handle:
* type: string
* title: product_handle
* description: The item's product handle.
* variant_sku:
* type: string
* title: variant_sku
* description: The item's variant sku.
* variant_barcode:
* type: string
* title: variant_barcode
* description: The item's variant barcode.
* variant_title:
* type: string
* title: variant_title
* description: The item's variant title.
* variant_option_values:
* type: object
* description: The item's variant option values.
* requires_shipping:
* type: boolean
* title: requires_shipping
* description: The item's requires shipping.
* is_discountable:
* type: boolean
* title: is_discountable
* description: The item's is discountable.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: The item's is tax inclusive.
* compare_at_unit_price:
* type: number
* title: compare_at_unit_price
* description: The item's compare at unit price.
* raw_compare_at_unit_price:
* type: object
* description: The item's raw compare at unit price.
* unit_price:
* type: number
* title: unit_price
* description: The item's unit price.
* raw_unit_price:
* type: object
* description: The item's raw unit price.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* raw_quantity:
* type: object
* description: The item's raw quantity.
* tax_lines:
* type: array
* description: The item's tax lines.
* items:
* $ref: "#/components/schemas/OrderLineItemTaxLine"
* adjustments:
* type: array
* description: The item's adjustments.
* items:
* $ref: "#/components/schemas/OrderLineItemAdjustment"
* detail:
* $ref: "#/components/schemas/OrderItem"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The item's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The item's updated at.
* metadata:
* type: object
* description: The item's metadata.
* original_total:
* oneOf:
* - type: string
* title: original_total
* description: The item's original total.
* - type: number
* title: original_total
* description: The item's original total.
* - type: string
* title: original_total
* description: The item's original total.
* - $ref: "#/components/schemas/IBigNumber"
* original_subtotal:
* oneOf:
* - type: string
* title: original_subtotal
* description: The item's original subtotal.
* - type: number
* title: original_subtotal
* description: The item's original subtotal.
* - type: string
* title: original_subtotal
* description: The item's original subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_tax_total:
* oneOf:
* - type: string
* title: original_tax_total
* description: The item's original tax total.
* - type: number
* title: original_tax_total
* description: The item's original tax total.
* - type: string
* title: original_tax_total
* description: The item's original tax total.
* - $ref: "#/components/schemas/IBigNumber"
* item_total:
* oneOf:
* - type: string
* title: item_total
* description: The item's item total.
* - type: number
* title: item_total
* description: The item's item total.
* - type: string
* title: item_total
* description: The item's item total.
* - $ref: "#/components/schemas/IBigNumber"
* item_subtotal:
* oneOf:
* - type: string
* title: item_subtotal
* description: The item's item subtotal.
* - type: number
* title: item_subtotal
* description: The item's item subtotal.
* - type: string
* title: item_subtotal
* description: The item's item subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* item_tax_total:
* oneOf:
* - type: string
* title: item_tax_total
* description: The item's item tax total.
* - type: number
* title: item_tax_total
* description: The item's item tax total.
* - type: string
* title: item_tax_total
* description: The item's item tax total.
* - $ref: "#/components/schemas/IBigNumber"
* total:
* oneOf:
* - type: string
* title: total
* description: The item's total.
* - type: number
* title: total
* description: The item's total.
* - type: string
* title: total
* description: The item's total.
* - $ref: "#/components/schemas/IBigNumber"
* subtotal:
* oneOf:
* - type: string
* title: subtotal
* description: The item's subtotal.
* - type: number
* title: subtotal
* description: The item's subtotal.
* - type: string
* title: subtotal
* description: The item's subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* tax_total:
* oneOf:
* - type: string
* title: tax_total
* description: The item's tax total.
* - type: number
* title: tax_total
* description: The item's tax total.
* - type: string
* title: tax_total
* description: The item's tax total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_total:
* oneOf:
* - type: string
* title: discount_total
* description: The item's discount total.
* - type: number
* title: discount_total
* description: The item's discount total.
* - type: string
* title: discount_total
* description: The item's discount total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_tax_total:
* oneOf:
* - type: string
* title: discount_tax_total
* description: The item's discount tax total.
* - type: number
* title: discount_tax_total
* description: The item's discount tax total.
* - type: string
* title: discount_tax_total
* description: The item's discount tax total.
* - $ref: "#/components/schemas/IBigNumber"
* refundable_total:
* oneOf:
* - type: string
* title: refundable_total
* description: The item's refundable total.
* - type: number
* title: refundable_total
* description: The item's refundable total.
* - type: string
* title: refundable_total
* description: The item's refundable total.
* - $ref: "#/components/schemas/IBigNumber"
* refundable_total_per_unit:
* oneOf:
* - type: string
* title: refundable_total_per_unit
* description: The item's refundable total per unit.
* - type: number
* title: refundable_total_per_unit
* description: The item's refundable total per unit.
* - type: string
* title: refundable_total_per_unit
* description: The item's refundable total per unit.
* - $ref: "#/components/schemas/IBigNumber"
* raw_original_total:
* type: object
* description: The item's raw original total.
* raw_original_subtotal:
* type: object
* description: The item's raw original subtotal.
* raw_original_tax_total:
* type: object
* description: The item's raw original tax total.
* raw_item_total:
* type: object
* description: The item's raw item total.
* raw_item_subtotal:
* type: object
* description: The item's raw item subtotal.
* raw_item_tax_total:
* type: object
* description: The item's raw item tax total.
* raw_total:
* type: object
* description: The item's raw total.
* raw_subtotal:
* type: object
* description: The item's raw subtotal.
* raw_tax_total:
* type: object
* description: The item's raw tax total.
* raw_discount_total:
* type: object
* description: The item's raw discount total.
* raw_discount_tax_total:
* type: object
* description: The item's raw discount tax total.
* raw_refundable_total:
* type: object
* description: The item's raw refundable total.
* raw_refundable_total_per_unit:
* type: object
* description: The item's raw refundable total per unit.
*
*/

219
www/utils/generated/oas-output/schemas/OrderShippingMethod.ts Normal file
View File

@@ -0,0 +1,219 @@
/**
* @schema OrderShippingMethod
* type: object
* description: The shipping method's shipping methods.
* x-schemaName: OrderShippingMethod
* required:
* - id
* - order_id
* - name
* - amount
* - raw_amount
* - is_tax_inclusive
* - created_at
* - updated_at
* - original_total
* - original_subtotal
* - original_tax_total
* - total
* - subtotal
* - tax_total
* - discount_total
* - discount_tax_total
* - raw_original_total
* - raw_original_subtotal
* - raw_original_tax_total
* - raw_total
* - raw_subtotal
* - raw_tax_total
* - raw_discount_total
* - raw_discount_tax_total
* properties:
* id:
* type: string
* title: id
* description: The shipping method's ID.
* order_id:
* type: string
* title: order_id
* description: The shipping method's order id.
* name:
* type: string
* title: name
* description: The shipping method's name.
* description:
* type: string
* title: description
* description: The shipping method's description.
* amount:
* oneOf:
* - type: string
* title: amount
* description: The shipping method's amount.
* - type: number
* title: amount
* description: The shipping method's amount.
* - type: string
* title: amount
* description: The shipping method's amount.
* - $ref: "#/components/schemas/IBigNumber"
* raw_amount:
* type: object
* description: The shipping method's raw amount.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: The shipping method's is tax inclusive.
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The shipping method's shipping option id.
* data:
* type: object
* description: The shipping method's data.
* metadata:
* type: object
* description: The shipping method's metadata.
* tax_lines:
* type: array
* description: The shipping method's tax lines.
* items:
* $ref: "#/components/schemas/OrderShippingMethodTaxLine"
* adjustments:
* type: array
* description: The shipping method's adjustments.
* items:
* $ref: "#/components/schemas/OrderShippingMethodAdjustment"
* created_at:
* type: string
* format: date-time
* title: created_at
* description: The shipping method's created at.
* updated_at:
* type: string
* format: date-time
* title: updated_at
* description: The shipping method's updated at.
* original_total:
* oneOf:
* - type: string
* title: original_total
* description: The shipping method's original total.
* - type: number
* title: original_total
* description: The shipping method's original total.
* - type: string
* title: original_total
* description: The shipping method's original total.
* - $ref: "#/components/schemas/IBigNumber"
* original_subtotal:
* oneOf:
* - type: string
* title: original_subtotal
* description: The shipping method's original subtotal.
* - type: number
* title: original_subtotal
* description: The shipping method's original subtotal.
* - type: string
* title: original_subtotal
* description: The shipping method's original subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* original_tax_total:
* oneOf:
* - type: string
* title: original_tax_total
* description: The shipping method's original tax total.
* - type: number
* title: original_tax_total
* description: The shipping method's original tax total.
* - type: string
* title: original_tax_total
* description: The shipping method's original tax total.
* - $ref: "#/components/schemas/IBigNumber"
* total:
* oneOf:
* - type: string
* title: total
* description: The shipping method's total.
* - type: number
* title: total
* description: The shipping method's total.
* - type: string
* title: total
* description: The shipping method's total.
* - $ref: "#/components/schemas/IBigNumber"
* subtotal:
* oneOf:
* - type: string
* title: subtotal
* description: The shipping method's subtotal.
* - type: number
* title: subtotal
* description: The shipping method's subtotal.
* - type: string
* title: subtotal
* description: The shipping method's subtotal.
* - $ref: "#/components/schemas/IBigNumber"
* tax_total:
* oneOf:
* - type: string
* title: tax_total
* description: The shipping method's tax total.
* - type: number
* title: tax_total
* description: The shipping method's tax total.
* - type: string
* title: tax_total
* description: The shipping method's tax total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_total:
* oneOf:
* - type: string
* title: discount_total
* description: The shipping method's discount total.
* - type: number
* title: discount_total
* description: The shipping method's discount total.
* - type: string
* title: discount_total
* description: The shipping method's discount total.
* - $ref: "#/components/schemas/IBigNumber"
* discount_tax_total:
* oneOf:
* - type: string
* title: discount_tax_total
* description: The shipping method's discount tax total.
* - type: number
* title: discount_tax_total
* description: The shipping method's discount tax total.
* - type: string
* title: discount_tax_total
* description: The shipping method's discount tax total.
* - $ref: "#/components/schemas/IBigNumber"
* raw_original_total:
* type: object
* description: The shipping method's raw original total.
* raw_original_subtotal:
* type: object
* description: The shipping method's raw original subtotal.
* raw_original_tax_total:
* type: object
* description: The shipping method's raw original tax total.
* raw_total:
* type: object
* description: The shipping method's raw total.
* raw_subtotal:
* type: object
* description: The shipping method's raw subtotal.
* raw_tax_total:
* type: object
* description: The shipping method's raw tax total.
* raw_discount_total:
* type: object
* description: The shipping method's raw discount total.
* raw_discount_tax_total:
* type: object
* description: The shipping method's raw discount tax total.
*
*/

52
www/utils/generated/oas-output/schemas/RefundReasonFilters.ts Normal file
View File

@@ -0,0 +1,52 @@
/**
* @schema RefundReasonFilters
* type: object
* description: SUMMARY
* x-schemaName: RefundReasonFilters
* properties:
* id:
* oneOf:
* - type: string
* title: id
* description: The refund reason's ID.
* - type: array
* description: The refund reason's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* q:
* type: string
* title: q
* description: The refund reason's q.
* limit:
* type: number
* title: limit
* description: The refund reason's limit.
* offset:
* type: number
* title: offset
* description: The refund reason's offset.
* order:
* type: string
* title: order
* description: The refund reason's order.
* fields:
* type: string
* title: fields
* description: The refund reason's fields.
* $and:
* type: array
* description: The refund reason's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The refund reason's $or.
* items:
* type: object
* title: $or
*
*/