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

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

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

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-03 07:18:42 +00:00
committed by GitHub
parent 6652db45ef
commit edc19e748b
157 changed files with 16009 additions and 35955 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
www/utils/generated/oas-output/operations/admin/get_admin_customers.ts
View File

@@ -49,7 +49,7 @@
* 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: groups
* in: query
* required: true
* required: false
* schema:
* oneOf:
* - type: string
@@ -3323,6 +3323,14 @@
* items:
* type: object
* title: $or
* - name: has_account
* in: query
* description: Filter by whether the customer is registered.
* required: false
* schema:
* type: boolean
* title: has_account
* description: Filter by whether the customer is registered.
* security:
* - api_token: []
* - cookie_auth: []

3
www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts
View File

@@ -2,8 +2,7 @@
* @oas [get] /admin/customers/{id}/addresses/{address_id}
* operationId: GetCustomersIdAddressesAddress_id
* summary: List Addresses
* description: Retrieve a list of a customer's addresses. The addresses can be
* filtered by fields like `company`. The addresses can also be paginated.
* description: Retrieve a list of a customer's addresses. The addresses can be filtered by fields like `company`. The addresses can also be paginated.
* x-authenticated: true
* parameters:
* - name: id

20
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts
View File

@@ -935,6 +935,15 @@
* type: string
* title: fulfillment_status
* description: The fulfillment status's details.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by the payment status of the draft order.
@@ -946,6 +955,17 @@
* type: string
* title: payment_status
* description: The payment status's details.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id
* in: query
* description: Filter by region IDs to retrieve their associated draft orders.

3
www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts
View File

@@ -2,8 +2,7 @@
* @oas [get] /admin/draft-orders/{id}
* operationId: GetDraftOrdersId
* summary: Get a Draft Order
* description: Retrieve a draft order by its ID. You can expand the draft order's
* relations or select the fields that should be returned using the query parameters.
* description: Retrieve a draft order by its ID. You can expand the draft order's relations or select the fields that should be returned using the query parameters.
* x-authenticated: true
* parameters:
* - name: id

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

@@ -2,8 +2,7 @@
* @oas [get] /admin/exchanges/{id}
* operationId: GetExchangesId
* summary: Get an Exchange
* description: Retrieve an exchange by its ID. You can expand the exchange's
* relations or select the fields that should be returned using query parameters.
* description: Retrieve an exchange by its ID. You can expand the exchange's relations or select the fields that should be returned using query parameters.
* x-authenticated: true
* parameters:
* - name: id

2
www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts
View File

@@ -64,7 +64,7 @@
* - name: is_enabled
* in: query
* description: Filter by whether the fulfillment provider is enabled.
* required: true
* required: false
* schema:
* type: boolean
* title: is_enabled

3
www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts
View File

@@ -3,8 +3,7 @@
* operationId: GetFulfillmentSetsIdServiceZonesZone_id
* summary: Get a Service Zone in a Fulfillment Set
* x-sidebar-summary: Get a Service Zone
* description: Retrieve a service zone that belongs to a fulfillment set.
* be paginated.
* description: Retrieve a service zone that belongs to a fulfillment set. be paginated.
* x-authenticated: true
* parameters:
* - name: id

2
www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts
View File

@@ -362,6 +362,8 @@
* type: string
* title: location_id
* description: A location's ID.
* required:
* - location_id
* - name: $and
* in: query
* required: false

4
www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts
View File

@@ -2,9 +2,7 @@
* @oas [get] /admin/inventory-items/{id}/location-levels
* operationId: GetInventoryItemsIdLocationLevels
* summary: List Inventory Levels
* description: Retrieve a list of inventory levels associated with an inventory item. The
* inventory levels can be filtered by fields like `location_id`. The inventory
* levels can also be paginated.
* description: Retrieve a list of inventory levels associated with an inventory item. The inventory levels can be filtered by fields like `location_id`. The inventory levels can also be paginated.
* x-authenticated: true
* parameters:
* - name: id

6
www/utils/generated/oas-output/operations/admin/get_admin_invites.ts
View File

@@ -89,7 +89,7 @@
* in: query
* description: Filter by the invite's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the invite's creation date.
* properties:
@@ -208,7 +208,7 @@
* in: query
* description: Filter by the invite's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the invite's update date.
* properties:
@@ -327,7 +327,7 @@
* in: query
* description: Filter by the invite's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the invite's deletion date.
* properties:

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

@@ -77,14 +77,14 @@
* - type: string
* title: channel
* description: Filter by a notification channel.
* example: "email"
* example: email
* - type: array
* description: Filter by notification channels.
* items:
* type: string
* title: channel
* description: A notification channel.
* example: "email"
* example: email
* - name: $and
* in: query
* required: false

532
www/utils/generated/oas-output/operations/admin/get_admin_orders.ts
View File

@@ -95,6 +95,538 @@
* items:
* type: object
* title: $or
* - name: sales_channel_id
* in: query
* description: Filter by sales channel IDs to retrieve the orders associated with them.
* required: false
* schema:
* type: array
* description: Filter by sales channel IDs to retrieve the orders associated with them.
* items:
* type: string
* title: sales_channel_id
* description: A sales channel's ID.
* - name: fulfillment_status
* in: query
* description: Filter by the order's fulfillment status.
* required: false
* schema:
* type: array
* description: Filter by the order's fulfillment status.
* items:
* type: string
* description: A fulfillment status.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by the order's payment status.
* required: false
* schema:
* type: array
* description: Filter by the order's payment status.
* items:
* type: string
* description: A payment status
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id
* in: query
* description: Filter by region IDs to retrieve their associated orders.
* required: false
* schema:
* type: array
* description: Filter by region IDs to retrieve their associated orders.
* items:
* type: string
* title: region_id
* description: A region ID.
* - name: q
* in: query
* description: Search term to filter the order's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: Search term to filter the order's searchable properties.
* - name: created_at
* in: query
* description: Filter by the order's creation date.
* required: false
* schema:
* type: object
* description: Filter by the order'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 multiple exact matches.
* items:
* type: string
* title: $eq
* description: 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: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* 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 multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $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: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $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: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $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 order's update date.
* required: false
* schema:
* type: object
* description: Filter by the order'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 multiple exact matches.
* items:
* type: string
* title: $eq
* description: 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: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* 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 multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $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: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $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: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []

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

@@ -3,10 +3,9 @@
* operationId: GetOrdersIdChanges
* summary: List Changes on an Order
* x-sidebar-summary: List Changes
* description: >
* description: |
* Retrieve a list of changes made on an order, including returns, exchanges, etc...
*
*
*
* The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated.
* x-authenticated: true
* parameters:

6
www/utils/generated/oas-output/operations/admin/get_admin_payments.ts
View File

@@ -87,7 +87,7 @@
* in: query
* description: Filter by the payment's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the payment's creation date.
* properties:
@@ -206,7 +206,7 @@
* in: query
* description: Filter by the payment's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the payment's update date.
* properties:
@@ -325,7 +325,7 @@
* in: query
* description: Filter by the payment's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the payment's deletion date.
* properties:

2
www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts
View File

@@ -49,7 +49,7 @@
* 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
* required: true
* schema:
* oneOf:
* - type: string

6
www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts
View File

@@ -147,7 +147,7 @@
* in: query
* description: Filter by the category's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the category's creation date.
* properties:
@@ -266,7 +266,7 @@
* in: query
* description: Filter by the category's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the category's update date.
* properties:
@@ -385,7 +385,7 @@
* in: query
* description: Filter by the category's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the category's deletion date.
* properties:

6
www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts
View File

@@ -87,7 +87,7 @@
* in: query
* description: Filter by the tag's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the tag's creation date.
* properties:
@@ -206,7 +206,7 @@
* in: query
* description: Filter by the tag's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the tag's update date.
* properties:
@@ -325,7 +325,7 @@
* in: query
* description: Filter by the tag's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the tag's deletion date.
* properties:

6
www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts
View File

@@ -87,7 +87,7 @@
* in: query
* description: Filter by the type's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the type's creation date.
* properties:
@@ -206,7 +206,7 @@
* in: query
* description: Filter by the type's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the type's update date.
* properties:
@@ -325,7 +325,7 @@
* in: query
* description: Filter by the type's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the type's deletion date.
* properties:

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

@@ -96,7 +96,7 @@
* in: query
* description: Filter by the product's creation date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the product's creation date.
* properties:
@@ -215,7 +215,7 @@
* in: query
* description: Filter by the product's update date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the product's update date.
* properties:
@@ -334,7 +334,7 @@
* in: query
* description: Filter by the product's deletion date.
* required: false
* schema:
* schema:
* type: object
* description: Filter by the product's deletion date.
* properties:

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

@@ -3,7 +3,7 @@
* operationId: GetPromotionsIdRule_type
* summary: List Rules of a Promotion
* x-sidebar-summary: List Rules
* description: >
* 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.
@@ -69,28 +69,6 @@
* 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: []

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

@@ -3,11 +3,9 @@
* operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id
* summary: List Rule Values Given a Rule Attribute
* x-sidebar-summary: List Rule Values
* description: >
* 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.
* 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

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

@@ -156,55 +156,6 @@
* $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: Filter by a reserved quantity.
* required: false
* schema:
* description: The reservation's quantity.
* properties:
* $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: Filter by a reservation's creation date.

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

@@ -95,6 +95,538 @@
* items:
* type: object
* title: $or
* - name: sales_channel_id
* in: query
* description: Filter by sales channel IDs to retrieve their associated returns.
* required: false
* schema:
* type: array
* description: Filter by sales channel IDs to retrieve their associated returns.
* items:
* type: string
* title: sales_channel_id
* description: A sales channel's ID.
* - name: fulfillment_status
* in: query
* description: Filter by fulfillment statuses.
* required: false
* schema:
* type: array
* description: Filter by fulfillment statuses.
* items:
* type: string
* description: A fulfillment status.
* enum:
* - canceled
* - not_fulfilled
* - partially_fulfilled
* - fulfilled
* - partially_shipped
* - shipped
* - partially_delivered
* - delivered
* - name: payment_status
* in: query
* description: Filter by payment statuses.
* required: false
* schema:
* type: array
* description: Filter by payment statuses.
* items:
* type: string
* description: A payment status.
* enum:
* - canceled
* - not_paid
* - awaiting
* - authorized
* - partially_authorized
* - captured
* - partially_captured
* - partially_refunded
* - refunded
* - requires_action
* - name: region_id
* in: query
* description: Filter by region IDs to retrieve their associated returns.
* required: false
* schema:
* type: array
* description: Filter by region IDs to retrieve their associated returns.
* items:
* type: string
* title: region_id
* description: The region id's details.
* - name: q
* in: query
* description: Search term to filter the return's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: Search term to filter the return's searchable properties.
* - name: created_at
* in: query
* description: Filter by the return's creation date.
* required: false
* schema:
* type: object
* description: Filter by the return'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 multiple exact matches.
* items:
* type: string
* title: $eq
* description: 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: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* 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 multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $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: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $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: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $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 return's update date.
* required: false
* schema:
* type: object
* description: Filter by the return'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 multiple exact matches.
* items:
* type: string
* title: $eq
* description: 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: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value not to match.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* 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 multiple exact matches.
* items:
* type: string
* title: $eq
* description: The value to match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: The value to match.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: The value to not match
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching this parameter
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the values of this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $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: The value to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching those in this parameter.
* items:
* type: string
* title: $not
* description: The values to not match.
* $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: The values to match.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: The values to match.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: The values to match.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* security:
* - api_token: []
* - cookie_auth: []

16
www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts
View File

@@ -496,6 +496,22 @@
* type: string
* title: stock_location_id
* description: A stock location's ID.
* - name: is_return
* in: query
* description: Filter by whether the shipping option is used for returns.
* required: false
* schema:
* type: boolean
* title: is_return
* description: Filter by whether the shipping option is used for returns.
* - name: admin_only
* in: query
* description: Filter by whether the shipping option is used by admin users only.
* required: false
* schema:
* type: boolean
* title: admin_only
* description: Filter by whether the shipping option is used by admin users only.
* security:
* - api_token: []
* - cookie_auth: []

2
www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts
View File

@@ -64,7 +64,7 @@
* title: id
* description: Filter by a stock location ID.
* - type: array
* description: Filter by stock location IDs.
* description: Filter by stock location IDs.
* items:
* type: string
* title: id

1
www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts
View File

@@ -123,7 +123,6 @@
* enum:
* - "true"
* - "false"
* title: is_default
* - name: created_at
* in: query
* description: Filter by a tax rate's creation date.

1012
www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts
View File

File diff suppressed because it is too large Load Diff

7
www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts
View File

@@ -3,9 +3,8 @@
* operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe
* summary: Subscribe to Step of a Workflow's Execution
* x-sidebar-summary: Subscribe to Step
* description: >
* description: |
* Subscribe to a step in a workflow's execution to receive real-time information about its status and data.
*
* This route returns an event stream that you can consume using the [EventSource API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
* x-authenticated: true
* parameters:
@@ -47,7 +46,9 @@
* schema:
* type: string
* description: The step's status update and data changes.
* example: "event: success\n data: {}"
* example: |-
* event: success
* data: {}
* "400":
* $ref: "#/components/responses/400_error"
* "401":

7
www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts
View File

@@ -3,9 +3,8 @@
* operationId: GetWorkflowsExecutionsWorkflow_idSubscribe
* summary: Subscribe to a Workflow's Execution
* x-sidebar-summary: Subscribe to Workflow
* description: >
* description: |
* Subscribe to a workflow's execution to receive real-time information about its steps, status, and data.
*
* This route returns an event stream that you can consume using the [EventSource API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
* x-authenticated: true
* parameters:
@@ -35,7 +34,9 @@
* schema:
* type: string
* description: The step's status update and data changes.
* example: "event: success\n data: {}"
* example: |-
* event: success
* data: {}
* "400":
* $ref: "#/components/responses/400_error"
* "401":

19
www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts
View File

@@ -55,24 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - name
* - type
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The shipping profile's name.
* type:
* type: string
* title: type
* description: The shipping profile's type.
* metadata:
* type: object
* description: The shipping profile's metadata.
* $ref: "#/components/schemas/AdminCreateShippingProfile"
* x-codeSamples:
* - lang: Shell
* label: cURL

2
www/utils/generated/oas-output/schemas/AdminCreateInventoryItem.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminCreateInventoryItem
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateInventoryItem
* properties:
* sku:
* type: string
@@ -58,7 +59,6 @@
* metadata:
* type: object
* description: The inventory item's metadata.
* x-schemaName: AdminCreateInventoryItem
*
*/

8
www/utils/generated/oas-output/schemas/AdminCreateProductCategory.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminCreateProductCategory
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateProductCategory
* required:
* - name
* properties:
@@ -29,14 +30,13 @@
* type: string
* title: parent_category_id
* description: The product category's parent category id.
* metadata:
* type: object
* description: The product category's metadata.
* rank:
* type: number
* title: rank
* description: The product category's rank.
* x-schemaName: AdminCreateProductCategory
* metadata:
* type: object
* description: The product category's metadata.
*
*/

2
www/utils/generated/oas-output/schemas/AdminCreateProductTag.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminCreateProductTag
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateProductTag
* required:
* - value
* properties:
@@ -12,7 +13,6 @@
* metadata:
* type: object
* description: The product tag's metadata.
* x-schemaName: AdminCreateProductTag
*
*/

2
www/utils/generated/oas-output/schemas/AdminCreateRefundReason.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminCreateRefundReason
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateRefundReason
* required:
* - label
* properties:
@@ -13,7 +14,6 @@
* type: string
* title: description
* description: The refund reason's description.
* x-schemaName: AdminCreateRefundReason
*
*/

10
www/utils/generated/oas-output/schemas/AdminCreateRegion.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminCreateRegion
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateRegion
* required:
* - name
* - currency_code
@@ -25,6 +26,10 @@
* type: boolean
* title: automatic_taxes
* description: The region's automatic taxes.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: The region's is tax inclusive.
* payment_providers:
* type: array
* description: The region's payment providers.
@@ -35,11 +40,6 @@
* metadata:
* type: object
* description: The region's metadata.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: The region's is tax inclusive.
* x-schemaName: AdminCreateRegion
*
*/

2
www/utils/generated/oas-output/schemas/AdminCreateReservation.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminCreateReservation
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateReservation
* required:
* - location_id
* - inventory_item_id
@@ -30,7 +31,6 @@
* metadata:
* type: object
* description: The reservation's metadata.
* x-schemaName: AdminCreateReservation
*
*/

7
www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminCreateShippingOption
* type: object
* description: SUMMARY
* x-schemaName: AdminCreateShippingOption
* required:
* - name
* - service_zone_id
@@ -28,9 +29,10 @@
* description: The shipping option's data.
* price_type:
* type: string
* description: The shipping option's price type.
* enum:
* - calculated
* - flat
* - calculated
* provider_id:
* type: string
* title: provider_id
@@ -44,6 +46,7 @@
* oneOf:
* - type: object
* description: The price's prices.
* x-schemaName: AdminCreateShippingOptionPriceWithCurrency
* required:
* - currency_code
* - amount
@@ -58,6 +61,7 @@
* description: The price's amount.
* - type: object
* description: The price's prices.
* x-schemaName: AdminCreateShippingOptionPriceWithRegion
* required:
* - region_id
* - amount
@@ -75,7 +79,6 @@
* description: The shipping option's rules.
* items:
* $ref: "#/components/schemas/AdminCreateShippingOptionRule"
* x-schemaName: AdminCreateShippingOption
*
*/

11
www/utils/generated/oas-output/schemas/AdminCreateShippingOptionRule.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminCreateShippingOptionRule
* type: object
* description: The rule's rules.
* x-schemaName: AdminCreateShippingOptionRule
* required:
* - operator
* - attribute
@@ -9,14 +10,15 @@
* properties:
* operator:
* type: string
* description: The rule's operator.
* enum:
* - in
* - gt
* - lt
* - eq
* - ne
* - gt
* - gte
* - lt
* - in
* - lte
* - gte
* - nin
* attribute:
* type: string
@@ -33,7 +35,6 @@
* type: string
* title: value
* description: The value's details.
* x-schemaName: AdminCreateShippingOptionRule
*
*/

23
www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts Normal file
View File

@@ -0,0 +1,23 @@
/**
* @schema AdminCreateShippingProfile
* type: object
* description: SUMMARY
* required:
* - name
* - type
* properties:
* name:
* type: string
* title: name
* description: The shipping profile's name.
* type:
* type: string
* title: type
* description: The shipping profile's type.
* metadata:
* type: object
* description: The shipping profile's metadata.
* x-schemaName: AdminCreateShippingProfile
*
*/

80
www/utils/generated/oas-output/schemas/AdminCustomerAddressFilters.ts
View File

@@ -1,80 +0,0 @@
/**
* @schema AdminCustomerAddressFilters
* type: object
* description: SUMMARY
* x-schemaName: AdminCustomerAddressFilters
* properties:
* q:
* type: string
* title: q
* description: The customer's q.
* company:
* oneOf:
* - type: string
* title: company
* description: The customer's company.
* - type: array
* description: The customer's company.
* items:
* type: string
* title: company
* description: The company's details.
* city:
* oneOf:
* - type: string
* title: city
* description: The customer's city.
* - type: array
* description: The customer's city.
* items:
* type: string
* title: city
* description: The city's details.
* country_code:
* oneOf:
* - type: string
* title: country_code
* description: The customer's country code.
* - type: array
* description: The customer's country code.
* items:
* type: string
* title: country_code
* description: The country code's details.
* province:
* oneOf:
* - type: string
* title: province
* description: The customer's province.
* - type: array
* description: The customer's province.
* items:
* type: string
* title: province
* description: The province's details.
* postal_code:
* oneOf:
* - type: string
* title: postal_code
* description: The customer's postal code.
* - type: array
* description: The customer's postal code.
* items:
* type: string
* title: postal_code
* description: The postal code's details.
* $and:
* type: array
* description: The customer's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The customer's $or.
* items:
* type: object
* title: $or
*
*/

2327
www/utils/generated/oas-output/schemas/AdminCustomerFilters.ts
View File

File diff suppressed because it is too large Load Diff

16
www/utils/generated/oas-output/schemas/AdminCustomerInGroupFilters.ts
View File

@@ -33,13 +33,13 @@
* properties:
* $and:
* type: array
* description: The email'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
* $or:
* type: array
* description: The email'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
@@ -214,13 +214,13 @@
* properties:
* $and:
* type: array
* description: The created at'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
* $or:
* type: array
* description: The created at'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
@@ -329,13 +329,13 @@
* properties:
* $and:
* type: array
* description: The updated at'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
* $or:
* type: array
* description: The updated at'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
@@ -444,13 +444,13 @@
* properties:
* $and:
* type: array
* description: The deleted at'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
* $or:
* type: array
* description: The deleted at'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

6
www/utils/generated/oas-output/schemas/AdminDeletePaymentCollectionResponse.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminDeletePaymentCollectionResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminDeletePaymentCollectionResponse
* required:
* - id
* - object
@@ -14,13 +15,12 @@
* object:
* type: string
* title: object
* description: The name of the deleted object.
* description: SUMMARY
* default: payment-collection
* deleted:
* type: boolean
* title: deleted
* description: Whether the payment collection was deleted.
* x-schemaName: AdminDeletePaymentCollectionResponse
* description: SUMMARY
*
*/

4
www/utils/generated/oas-output/schemas/AdminExchangeDeleteResponse.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminExchangeDeleteResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminExchangeDeleteResponse
* required:
* - id
* - object
@@ -19,8 +20,7 @@
* deleted:
* type: boolean
* title: deleted
* description: Whether the exchange was deleted.
* x-schemaName: AdminExchangeDeleteResponse
* description: Whether the Exchange was deleted.
*
*/

755
www/utils/generated/oas-output/schemas/AdminExchangeListParams.ts
View File

@@ -1,755 +0,0 @@
/**
* @schema AdminExchangeListParams
* type: object
* description: SUMMARY
* x-schemaName: AdminExchangeListParams
* properties:
* deleted_at:
* type: object
* description: The exchange's deleted at.
* properties:
* $and:
* type: array
* description: The deleted at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The deleted at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* q:
* type: string
* title: q
* description: The exchange's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The exchange's ID.
* - type: array
* description: The exchange's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* order_id:
* oneOf:
* - type: string
* title: order_id
* description: The exchange's order id.
* - type: array
* description: The exchange's order id.
* items:
* type: string
* title: order_id
* description: The order id's details.
* status:
* oneOf:
* - type: string
* title: status
* description: The exchange's status.
* - type: array
* description: The exchange's status.
* items:
* type: string
* title: status
* description: The status's details.
* created_at:
* type: object
* description: The exchange's created at.
* properties:
* $and:
* type: array
* description: The created at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The created at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* updated_at:
* type: object
* description: The exchange's updated at.
* properties:
* $and:
* type: array
* description: The updated at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The updated at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* limit:
* type: number
* title: limit
* description: The exchange's limit.
* offset:
* type: number
* title: offset
* description: The exchange's offset.
* order:
* type: string
* title: order
* description: The exchange's order.
* fields:
* type: string
* title: fields
* description: The exchange's fields.
* $and:
* type: array
* description: The exchange's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The exchange's $or.
* items:
* type: object
* title: $or
*
*/

22
www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts
View File

@@ -1,7 +1,17 @@
/**
* @schema AdminFulfillmentSet
* type: object
* description: The fulfillment set that the service zone belongs to.
* description: The fulfillment set's parent.
* x-schemaName: AdminFulfillmentSet
* required:
* - id
* - name
* - type
* - location
* - service_zones
* - created_at
* - updated_at
* - deleted_at
* properties:
* id:
* type: string
@@ -37,16 +47,6 @@
* format: date-time
* title: deleted_at
* description: The parent's deleted at.
* required:
* - id
* - name
* - type
* - location
* - service_zones
* - created_at
* - updated_at
* - deleted_at
* x-schemaName: AdminFulfillmentSet
*
*/

759
www/utils/generated/oas-output/schemas/AdminGetCustomerGroupsParams.ts
View File

@@ -1,759 +0,0 @@
/**
* @schema AdminGetCustomerGroupsParams
* type: object
* description: SUMMARY
* x-schemaName: AdminGetCustomerGroupsParams
* properties:
* limit:
* type: number
* title: limit
* description: The customer group's limit.
* offset:
* type: number
* title: offset
* description: The customer group's offset.
* q:
* type: string
* title: q
* description: The customer group's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The customer group's ID.
* - type: array
* description: The customer group's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* name:
* oneOf:
* - type: string
* title: name
* description: The customer group's name.
* - type: array
* description: The customer group's name.
* items:
* type: string
* title: name
* description: The name's details.
* customers:
* oneOf:
* - type: string
* title: customers
* description: The customer group's customers.
* - type: array
* description: The customer group's customers.
* items:
* type: string
* title: customers
* description: The customer's customers.
* - $ref: "#/components/schemas/AdminCustomerInGroupFilters"
* created_by:
* oneOf:
* - type: string
* title: created_by
* description: The customer group's created by.
* - type: array
* description: The customer group's created by.
* items:
* type: string
* title: created_by
* description: The created by's details.
* created_at:
* type: object
* description: The customer group's created at.
* properties:
* $and:
* type: array
* description: The created at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The created at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* updated_at:
* type: object
* description: The customer group's updated at.
* properties:
* $and:
* type: array
* description: The updated at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The updated at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* deleted_at:
* type: object
* description: The customer group's deleted at.
* properties:
* $and:
* type: array
* description: The deleted at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The deleted at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* $and:
* type: array
* description: The customer group's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The customer group's $or.
* items:
* type: object
* title: $or
*
*/

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

@@ -1,17 +0,0 @@
/**
* @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
View File

@@ -1,59 +0,0 @@
/**
* @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
*
*/

522
www/utils/generated/oas-output/schemas/AdminPriceListListParams.ts
View File

@@ -1,522 +0,0 @@
/**
* @schema AdminPriceListListParams
* type: object
* description: SUMMARY
* x-schemaName: AdminPriceListListParams
* properties:
* q:
* type: string
* title: q
* description: The price list's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The price list's ID.
* - type: array
* description: The price list's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* starts_at:
* type: object
* description: The price list's starts at.
* properties:
* $and:
* type: array
* description: The starts at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The starts at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* ends_at:
* type: object
* description: The price list's ends at.
* properties:
* $and:
* type: array
* description: The ends at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The ends at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* status:
* type: array
* description: The price list's status.
* items:
* type: string
* description: The status's details.
* enum:
* - active
* - draft
* rules_count:
* type: array
* description: The price list's rules count.
* items:
* type: number
* title: rules_count
* description: The rules count's details.
* limit:
* type: number
* title: limit
* description: The price list's limit.
* offset:
* type: number
* title: offset
* description: The price list's offset.
* order:
* type: string
* title: order
* description: The price list's order.
* fields:
* type: string
* title: fields
* description: The price list's fields.
* $and:
* type: array
* description: The price list's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The price list's $or.
* items:
* type: object
* title: $or
*
*/

74
www/utils/generated/oas-output/schemas/AdminPricePreferenceListParams.ts
View File

@@ -1,74 +0,0 @@
/**
* @schema AdminPricePreferenceListParams
* type: object
* description: SUMMARY
* x-schemaName: AdminPricePreferenceListParams
* properties:
* id:
* oneOf:
* - type: string
* title: id
* description: The price preference's ID.
* - type: array
* description: The price preference's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* attribute:
* oneOf:
* - type: string
* title: attribute
* description: The price preference's attribute.
* - type: array
* description: The price preference's attribute.
* items:
* type: string
* title: attribute
* description: The attribute's details.
* value:
* oneOf:
* - type: string
* title: value
* description: The price preference's value.
* - type: array
* description: The price preference's value.
* items:
* type: string
* title: value
* description: The value's details.
* q:
* type: string
* title: q
* description: The price preference's q.
* limit:
* type: number
* title: limit
* description: The price preference's limit.
* offset:
* type: number
* title: offset
* description: The price preference's offset.
* order:
* type: string
* title: order
* description: The price preference's order.
* fields:
* type: string
* title: fields
* description: The price preference's fields.
* $and:
* type: array
* description: The price preference's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The price preference's $or.
* items:
* type: object
* title: $or
*
*/

362
www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts
View File

@@ -1,20 +1,20 @@
/**
* @schema AdminProductVariantParams
* type: object
* description: The product's variants.
* description: SUMMARY
* x-schemaName: AdminProductVariantParams
* properties:
* q:
* type: string
* title: q
* description: The variant's q.
* description: The product's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The variant's ID.
* description: The product's ID.
* - type: array
* description: The variant's ID.
* description: The product's ID.
* items:
* type: string
* title: id
@@ -22,14 +22,14 @@
* manage_inventory:
* type: boolean
* title: manage_inventory
* description: The variant's manage inventory.
* description: The product's manage inventory.
* allow_backorder:
* type: boolean
* title: allow_backorder
* description: The variant's allow backorder.
* description: The product's allow backorder.
* created_at:
* type: object
* description: The variant's created at.
* description: The product's created at.
* properties:
* $and:
* type: array
@@ -79,6 +79,118 @@
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* 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`).
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
@@ -144,7 +256,7 @@
* description: Filter by whether a value for this parameter exists (not `null`).
* updated_at:
* type: object
* description: The variant's updated at.
* description: The product's updated at.
* properties:
* $and:
* type: array
@@ -194,6 +306,118 @@
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* 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`).
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
@@ -259,7 +483,7 @@
* description: Filter by whether a value for this parameter exists (not `null`).
* deleted_at:
* type: object
* description: The variant's deleted at.
* description: The product's deleted at.
* properties:
* $and:
* type: array
@@ -309,6 +533,118 @@
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* 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`).
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
@@ -375,19 +711,19 @@
* limit:
* type: number
* title: limit
* description: The variant's limit.
* description: The product's limit.
* offset:
* type: number
* title: offset
* description: The variant's offset.
* description: The product's offset.
* order:
* type: string
* title: order
* description: The variant's order.
* description: The product's order.
* fields:
* type: string
* title: fields
* description: The variant's fields.
* description: The product's fields.
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

4
www/utils/generated/oas-output/schemas/AdminReturnReasonDeleteResponse.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminReturnReasonDeleteResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminReturnReasonDeleteResponse
* required:
* - id
* - object
@@ -19,8 +20,7 @@
* deleted:
* type: boolean
* title: deleted
* description: Whether the return reason was deleted.
* x-schemaName: AdminReturnReasonDeleteResponse
* description: Whether the Return Reason was deleted.
*
*/

7
www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts
View File

@@ -2,6 +2,7 @@
* @schema AdminServiceZoneDeleteResponse
* type: object
* description: SUMMARY
* x-schemaName: AdminServiceZoneDeleteResponse
* required:
* - id
* - object
@@ -10,19 +11,17 @@
* id:
* type: string
* title: id
* description: The service zone's ID.
* description: The fulfillment set's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: service_zone
* deleted:
* type: boolean
* title: deleted
* description: Whether the service zone was deleted.
* description: Whether the Fulfillment Set was deleted.
* parent:
* $ref: "#/components/schemas/AdminFulfillmentSet"
* x-schemaName: AdminServiceZoneDeleteResponse
*
*/

1162
www/utils/generated/oas-output/schemas/AdminTaxRateListParams.ts
View File

File diff suppressed because it is too large Load Diff

734
www/utils/generated/oas-output/schemas/AdminUserListParams.ts
View File

@@ -1,734 +0,0 @@
/**
* @schema AdminUserListParams
* type: object
* description: SUMMARY
* x-schemaName: AdminUserListParams
* properties:
* q:
* type: string
* title: q
* description: The user's q.
* id:
* oneOf:
* - type: string
* title: id
* description: The user's ID.
* - type: array
* description: The user's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* email:
* type: string
* title: email
* description: The user's email.
* format: email
* first_name:
* type: string
* title: first_name
* description: The user's first name.
* last_name:
* type: string
* title: last_name
* description: The user's last name.
* created_at:
* type: object
* description: The user's created at.
* properties:
* $and:
* type: array
* description: The created at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The created at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* updated_at:
* type: object
* description: The user's updated at.
* properties:
* $and:
* type: array
* description: The updated at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The updated at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* deleted_at:
* type: object
* description: The user's deleted at.
* properties:
* $and:
* type: array
* description: The deleted at's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The deleted at's $or.
* 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.
* properties:
* $and:
* type: array
* description: The $not's $and.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: The $not's $or.
* 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`).
* - 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`).
* limit:
* type: number
* title: limit
* description: The user's limit.
* offset:
* type: number
* title: offset
* description: The user's offset.
* order:
* type: string
* title: order
* description: The user's order.
* fields:
* type: string
* title: fields
* description: The user's fields.
*
*/

12
www/utils/generated/oas-output/schemas/CustomerGroupInCustomerFilters.ts
View File

@@ -38,13 +38,13 @@
* properties:
* $and:
* type: array
* description: The created at'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
* $or:
* type: array
* description: The created at'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
@@ -153,13 +153,13 @@
* properties:
* $and:
* type: array
* description: The updated at'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
* $or:
* type: array
* description: The updated at'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
@@ -268,13 +268,13 @@
* properties:
* $and:
* type: array
* description: The deleted at'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
* $or:
* type: array
* description: The deleted at'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

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

@@ -1,364 +0,0 @@
/**
* @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
View File

@@ -1,219 +0,0 @@
/**
* @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
View File

@@ -1,52 +0,0 @@
/**
* @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
*
*/

2
www/utils/generated/oas-output/schemas/StoreCreatePaymentCollection.ts
View File

@@ -2,6 +2,7 @@
* @schema StoreCreatePaymentCollection
* type: object
* description: SUMMARY
* x-schemaName: StoreCreatePaymentCollection
* required:
* - cart_id
* properties:
@@ -9,7 +10,6 @@
* type: string
* title: cart_id
* description: The payment collection's cart id.
* x-schemaName: StoreCreatePaymentCollection
*
*/

2
www/utils/generated/oas-output/schemas/StoreCreateReturnItem.ts
View File

@@ -2,6 +2,7 @@
* @schema StoreCreateReturnItem
* type: object
* description: The item's items.
* x-schemaName: StoreCreateReturnItem
* required:
* - id
* - quantity
@@ -22,7 +23,6 @@
* type: string
* title: note
* description: The item's note.
* x-schemaName: StoreCreateReturnItem
*
*/

2
www/utils/generated/oas-output/schemas/StoreCreateReturnShipping.ts
View File

@@ -2,6 +2,7 @@
* @schema StoreCreateReturnShipping
* type: object
* description: The return's return shipping.
* x-schemaName: StoreCreateReturnShipping
* required:
* - option_id
* properties:
@@ -13,7 +14,6 @@
* type: number
* title: price
* description: The return shipping's price.
* x-schemaName: StoreCreateReturnShipping
*
*/