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

oas: [7/n] Improve admin OAS (#8902)

Browse Source
This commit is contained in:
Shahed Nasser
2024-09-02 09:39:14 +03:00
committed by GitHub
parent 0d24262bbe
commit 1f2ee24e1d
16 changed files with 4771 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

404
www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts
View File

@@ -49,12 +49,12 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The sales channel's q.
* description: Search term to filter the sales channel's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The sales channel's q.
* description: Search term to filter the sales channel's searchable properties.
* - name: id
* in: query
* required: false
@@ -62,13 +62,13 @@
* oneOf:
* - type: string
* title: id
* description: The sales channel's ID.
* description: Filter by a sales channel ID.
* - type: array
* description: The sales channel's ID.
* description: Filter by sales channel IDs.
* items:
* type: string
* title: id
* description: The id's ID.
* description: A sales channel ID.
* - name: name
* in: query
* required: false
@@ -76,13 +76,13 @@
* oneOf:
* - type: string
* title: name
* description: The sales channel's name.
* description: Filter by a sales channel name.
* - type: array
* description: The sales channel's name.
* description: Filter by sales channel names.
* items:
* type: string
* title: name
* description: The name's details.
* description: A sales channel name.
* - name: description
* in: query
* description: The sales channel's description.
@@ -90,30 +90,372 @@
* schema:
* type: string
* title: description
* description: The sales channel's description.
* description: Filter by a description. This filter matches an entire description. To search by terms or keywords, use the `q` query parameter instead.
* - name: is_disabled
* in: query
* description: The sales channel's is disabled.
* description: Filter by whether the sales channel is disabled.
* required: false
* schema:
* type: boolean
* title: is_disabled
* description: The sales channel's is disabled.
* description: Filter by whether the sales channel is disabled.
* - name: created_at
* in: query
* description: The sales channel's created at.
* description: Filter by a sales channel's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a sales channel's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The sales channel's updated at.
* description: Filter by a sales channel's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a sales channel's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The sales channel's deleted at.
* description: Filter by a sales channel's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a sales channel's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: location_id
* in: query
* required: false
@@ -121,13 +463,13 @@
* oneOf:
* - type: string
* title: location_id
* description: The sales channel's location id.
* description: Filter by a location ID to retrieve its associated sales channels.
* - type: array
* description: The sales channel's location id.
* description: Filter by location IDs to retrieve their associated sales channels.
* items:
* type: string
* title: location_id
* description: The location id's details.
* description: A location ID.
* - name: publishable_key_id
* in: query
* required: false
@@ -135,19 +477,19 @@
* oneOf:
* - type: string
* title: publishable_key_id
* description: The sales channel's publishable key id.
* description: Filter by a publishable API key's ID to retrieve its associated sales channels.
* - type: array
* description: The sales channel's publishable key id.
* description: Filter by publishable API key IDs to retrieve their associated sales channels.
* items:
* type: string
* title: publishable_key_id
* description: The publishable key id's details.
* description: A publishable API key ID.
* - name: $and
* in: query
* required: false
* schema:
* type: array
* description: The sales channel'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
@@ -156,7 +498,7 @@
* required: false
* schema:
* type: array
* description: The sales channel'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
@@ -180,7 +522,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of sales channels.
* required:
* - limit
* - offset
@@ -189,23 +531,23 @@
* limit:
* type: number
* title: limit
* description: The sales channel's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The sales channel's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The sales channel's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of sales channels.
* required:
* - sales_channels
* properties:
* sales_channels:
* type: array
* description: The sales channel's sales channels.
* description: The list of sales channels.
* items:
* $ref: "#/components/schemas/AdminSalesChannel"
* "400":

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

@@ -54,21 +54,21 @@
* oneOf:
* - type: string
* title: id
* description: The shipping option's ID.
* description: Filter by a shipping option ID.
* - type: array
* description: The shipping option's ID.
* description: Filter by shipping option IDs.
* items:
* type: string
* title: id
* description: The id's ID.
* description: A shipping option's ID.
* - name: q
* in: query
* description: The shipping option's q.
* description: Search term to filter the shipping option's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The shipping option's q.
* description: Search term to filter the shipping option's searchable properties.
* - name: service_zone_id
* in: query
* required: false
@@ -76,13 +76,13 @@
* oneOf:
* - type: string
* title: service_zone_id
* description: The shipping option's service zone id.
* description: Filter by a service zone's ID to retrieve its associated shipping options.
* - type: array
* description: The shipping option's service zone id.
* description: Filter by service zone IDs to retrieve their associated shipping options.
* items:
* type: string
* title: service_zone_id
* description: The service zone id's details.
* description: A service zone ID.
* - name: shipping_profile_id
* in: query
* required: false
@@ -90,13 +90,13 @@
* oneOf:
* - type: string
* title: shipping_profile_id
* description: The shipping option's shipping profile id.
* description: Filter by a shipping profile's ID to retrieve its associated shipping options.
* - type: array
* description: The shipping option's shipping profile id.
* description: Filter by shipping profile IDs to retrieve their associated shipping options.
* items:
* type: string
* title: shipping_profile_id
* description: The shipping profile id's details.
* description: A shipping profile ID.
* - name: provider_id
* in: query
* required: false
@@ -104,13 +104,13 @@
* oneOf:
* - type: string
* title: provider_id
* description: The shipping option's provider id.
* description: Filter by a fulfillment provider's ID to retrieve its associated shipping options.
* - type: array
* description: The shipping option's provider id.
* description: Filter by fulfillment provider IDs to retrieve their associated shipping options.
* items:
* type: string
* title: provider_id
* description: The provider id's details.
* description: A fulfillment provider ID.
* - name: shipping_option_type_id
* in: query
* required: false
@@ -118,28 +118,370 @@
* oneOf:
* - type: string
* title: shipping_option_type_id
* description: The shipping option's shipping option type id.
* description: Filter by a shipping option type's ID to retrieve its associated shipping options.
* - type: array
* description: The shipping option's shipping option type id.
* description: Filter by shipping option type IDs to retrieve its associated shipping options.
* items:
* type: string
* title: shipping_option_type_id
* description: The shipping option type id's details.
* description: A shipping option type ID.
* - name: created_at
* in: query
* description: The shipping option's created at.
* description: Filter by a shipping option's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a shipping option's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The shipping option's updated at.
* description: Filter by a shipping option's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a shipping option's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The shipping option's deleted at.
* description: Filter by a shipping option's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a shipping option's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: stock_location_id
* in: query
* required: false
@@ -147,13 +489,13 @@
* oneOf:
* - type: string
* title: stock_location_id
* description: The shipping option's stock location id.
* description: Filter by a location ID to retrieve its associated shipping option.
* - type: array
* description: The shipping option's stock location id.
* description: Filter by location IDs to retrieve their associated shipping option.
* items:
* type: string
* title: stock_location_id
* description: The stock location id's details.
* description: A stock location's ID.
* security:
* - api_token: []
* - cookie_auth: []
@@ -174,7 +516,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of shipping options.
* required:
* - limit
* - offset
@@ -183,23 +525,23 @@
* limit:
* type: number
* title: limit
* description: The shipping option's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The shipping option's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The shipping option's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of shipping options.
* required:
* - shipping_options
* properties:
* shipping_options:
* type: array
* description: The shipping option's shipping options.
* description: The list of shipping options.
* items:
* $ref: "#/components/schemas/AdminShippingOption"
* "400":

388
www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts
View File

@@ -54,58 +54,400 @@
* oneOf:
* - type: string
* title: id
* description: The shipping profile's ID.
* description: Filter by a shipping profile's ID.
* - type: array
* description: The shipping profile's ID.
* description: Filter by shipping profile IDs.
* items:
* type: string
* title: id
* description: The id's ID.
* description: A shipping profile ID.
* - name: q
* in: query
* description: The shipping profile's q.
* description: Search term to filter the shipping profile's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The shipping profile's q.
* description: Search term to filter the shipping profile's searchable properties.
* - name: type
* in: query
* description: The shipping profile's type.
* description: Filter by a shipping profile's type.
* required: false
* schema:
* type: string
* title: type
* description: The shipping profile's type.
* description: Filter by a shipping profile's type.
* - name: name
* in: query
* description: The shipping profile's name.
* description: Filter by a shipping profile's name.
* required: false
* schema:
* type: string
* title: name
* description: The shipping profile's name.
* description: Filter by a shipping profile's name.
* - name: created_at
* in: query
* description: The shipping profile's created at.
* description: Filter by a shipping profile's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a shipping profile's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The shipping profile's updated at.
* description: Filter by a shipping profile's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a shipping profile's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The shipping profile's deleted at.
* description: Filter by a shipping profile's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a shipping profile's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: $and
* in: query
* required: false
* schema:
* type: array
* description: The shipping profile'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
@@ -114,7 +456,7 @@
* required: false
* schema:
* type: array
* description: The shipping profile'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
@@ -138,7 +480,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of shipping profiles.
* required:
* - limit
* - offset
@@ -147,23 +489,23 @@
* limit:
* type: number
* title: limit
* description: The shipping profile's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The shipping profile's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The shipping profile's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of shipping profiles.
* required:
* - shipping_profiles
* properties:
* shipping_profiles:
* type: array
* description: The shipping profile's shipping profiles.
* description: The list of shipping profiles.
* items:
* $ref: "#/components/schemas/AdminShippingProfile"
* "400":

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

@@ -49,12 +49,12 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The stock location's q.
* description: Search term to filter the stock location's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The stock location's q.
* description: Search term to filter the stock location's searchable properties.
* - name: id
* in: query
* required: false
@@ -62,13 +62,13 @@
* oneOf:
* - type: string
* title: id
* description: The stock location's ID.
* description: Filter by a stock location ID.
* - type: array
* description: The stock location's ID.
* description: Filter by stock location IDs.
* items:
* type: string
* title: id
* description: The id's ID.
* description: A stock location ID.
* - name: name
* in: query
* required: false
@@ -76,13 +76,13 @@
* oneOf:
* - type: string
* title: name
* description: The stock location's name.
* description: Filter by a stock location name.
* - type: array
* description: The stock location's name.
* description: Filter by stock location names.
* items:
* type: string
* title: name
* description: The name's details.
* description: A stock location name.
* - name: address_id
* in: query
* required: false
@@ -90,13 +90,13 @@
* oneOf:
* - type: string
* title: address_id
* description: The stock location's address id.
* description: Filter by an address ID to retrieve its associated locations.
* - type: array
* description: The stock location's address id.
* description: Filter by address IDs to retrieve their associated locations.
* items:
* type: string
* title: address_id
* description: The address id's details.
* description: An address ID.
* - name: sales_channel_id
* in: query
* required: false
@@ -104,34 +104,376 @@
* oneOf:
* - type: string
* title: sales_channel_id
* description: The stock location's sales channel id.
* description: Filter by a sales channel ID to retrieve its associated locations.
* - type: array
* description: The stock location's sales channel id.
* description: Filter by sales channel IDs to retrieve their associated locations.
* items:
* type: string
* title: sales_channel_id
* description: The sales channel id's details.
* description: A sales channel ID
* - name: created_at
* in: query
* description: The stock location's created at.
* description: Filter by a stock location's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a stock location's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The stock location's updated at.
* description: Filter by a stock location's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a stock location's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The stock location's deleted at.
* description: Filter by a stock location's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a stock location's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: $and
* in: query
* required: false
* schema:
* type: array
* description: The stock location'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
@@ -140,7 +482,7 @@
* required: false
* schema:
* type: array
* description: The stock location'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

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

@@ -49,12 +49,12 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The store's q.
* description: Search term to filter the store's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The store's q.
* description: Search term to filter the store's searchable properties.
* - name: id
* in: query
* required: false
@@ -62,13 +62,13 @@
* oneOf:
* - type: string
* title: id
* description: The store's ID.
* description: Filter by a store ID.
* - type: array
* description: The store's ID.
* description: Filter by store IDs.
* items:
* type: string
* title: id
* description: The id's ID.
* description: A store ID.
* - name: name
* in: query
* required: false
@@ -76,19 +76,19 @@
* oneOf:
* - type: string
* title: name
* description: The store's name.
* description: Filter by a store name.
* - type: array
* description: The store's name.
* description: Filter by store names.
* items:
* type: string
* title: name
* description: The name's details.
* description: A store name.
* - name: $and
* in: query
* required: false
* schema:
* type: array
* description: The store'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
@@ -97,7 +97,7 @@
* required: false
* schema:
* type: array
* description: The store'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

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

@@ -49,12 +49,12 @@
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The tax rate's q.
* description: Search terms to filter the tax rate's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The tax rate's q.
* description: Search terms to filter the tax rate's searchable properties.
* - name: tax_region_id
* in: query
* required: false
@@ -62,70 +62,431 @@
* oneOf:
* - type: string
* title: tax_region_id
* description: The tax rate's tax region id.
* description: Filter by a tax region ID to retrieve its associated rates.
* - type: array
* description: The tax rate's tax region id.
* description: Filter by tax region IDs to retrieve their associated rates.
* items:
* type: string
* title: tax_region_id
* description: The tax region id's details.
* description: A tax region ID.
* - type: object
* description: The tax rate's tax region id.
* required:
* - $eq
* - $ne
* - $in
* - $nin
* - $like
* - $ilike
* - $re
* - $contains
* - $gt
* - $gte
* - $lt
* - $lte
* description: Apply filters on the tax region ID to retrieve the rates associated with the matching tax regions.
* properties:
* $eq: {}
* $ne: {}
* $in: {}
* $nin: {}
* $like: {}
* $ilike: {}
* $re: {}
* $contains: {}
* $gt: {}
* $gte: {}
* $lt: {}
* $lte: {}
* $eq:
* type: string
* description: Filter by an exact match.
* $ne:
* type: string
* description: Filter by values not matching this parameter.
* $in:
* type: array
* description: Filter by values in this array's items.
* items:
* type: string
* $nin:
* type: array
* description: Filter by values not in this array's items.
* items:
* type: string
* $like:
* type: string
* description: Apply a `like` filter. Useful for strings only.
* $ilike:
* type: string
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $re:
* type: string
* description: Apply a regex filter. Useful for strings only.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* $gt:
* type: string
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* - name: is_default
* in: query
* required: false
* description: Filter by whether the tax rate is a default in its tax region.
* schema:
* type: string
* enum:
* - "true"
* - "false"
* title: is_default
* - name: created_at
* in: query
* description: The tax rate's created at.
* description: Filter by a tax rate's creation date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a tax rate's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The tax rate's updated at.
* description: Filter by a tax rate's update date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a tax rate's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: The tax rate's deleted at.
* description: Filter by a tax rate's deletion date.
* required: false
* schema: {}
* schema:
* type: object
* description: Filter by a tax rate's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: $and
* in: query
* required: false
* schema:
* type: array
* description: The tax rate'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
@@ -134,10 +495,42 @@
* required: false
* schema:
* type: array
* description: The tax rate'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
* - name: service_zone_id
* in: query
* description: Filter by a service zone's ID to retrieve its associated tax rates.
* required: false
* schema:
* type: string
* title: service_zone_id
* description: Filter by a service zone's ID to retrieve its associated tax rates.
* - name: shipping_profile_id
* in: query
* description: Filter by a shipping profile's ID to retrieve its associated tax rates.
* required: false
* schema:
* type: string
* title: shipping_profile_id
* description: Filter by a shipping profile's ID to retrieve its associated tax rates.
* - name: provider_id
* in: query
* description: Filter by a fulfillment provider's ID to retrieve its associated tax rates.
* required: false
* schema:
* type: string
* title: provider_id
* description: Filter by a fulfillment provider's ID to retrieve its associated tax rates.
* - name: shipping_option_type_id
* in: query
* description: Filter by a shipping option type's ID to retrieve its associated tax rates.
* required: false
* schema:
* type: string
* title: shipping_option_type_id
* description: Filter by a shipping option type's ID to retrieve its associated tax rates.
* security:
* - api_token: []
* - cookie_auth: []
@@ -158,7 +551,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of tax rates.
* required:
* - limit
* - offset
@@ -167,17 +560,17 @@
* limit:
* type: number
* title: limit
* description: The tax rate's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The tax rate's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The tax rate's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of tax rates.
* required:
* - tax_rates
* properties:

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

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

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

@@ -1,8 +1,8 @@
/**
* @oas [get] /admin/uploads/{id}
* operationId: GetUploadsId
* summary: Get a Upload
* description: Retrieve a upload by its ID. You can expand the upload's relations or select the fields that should be returned.
* summary: Get a File
* description: Retrieve an uploaded file by its ID. You can expand the file's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id

404
www/utils/generated/oas-output/operations/admin/get_admin_users.ts
View File

@@ -47,6 +47,410 @@
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* - name: q
* in: query
* description: The search term to filter the user's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: The search term to filter the user's searchable properties.
* - name: id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: id
* description: Filter by a user's ID.
* - type: array
* description: Filter by user IDs.
* items:
* type: string
* title: id
* description: A user's ID.
* - name: email
* in: query
* description: Filter by an email.
* required: false
* schema:
* type: string
* title: email
* description: Filter by an email.
* format: email
* - name: first_name
* in: query
* description: Filter by a first name.
* required: false
* schema:
* type: string
* title: first_name
* description: Filter by a first name.
* - name: last_name
* in: query
* description: Filter by a last name.
* required: false
* schema:
* type: string
* title: last_name
* description: Filter by a last name.
* - name: created_at
* in: query
* description: Filter by a user's creation date.
* required: false
* schema:
* type: object
* description: Filter by a user's creation date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: Filter by a user's update date.
* required: false
* schema:
* type: object
* description: Filter by a user's update date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: deleted_at
* in: query
* description: Filter by a user's deletion date.
* required: false
* schema:
* type: object
* description: Filter by a user's deletion date.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* x-codeSamples:
* - lang: Shell
* label: cURL

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

@@ -1,8 +1,8 @@
/**
* @oas [get] /admin/users/me
* operationId: GetUsersMe
* summary: List Users
* description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated.
* summary: Get Logged-In User
* description: Retrieve the logged-in user's details.
* x-authenticated: false
* parameters:
* - name: expand

22
www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts
View File

@@ -54,13 +54,13 @@
* oneOf:
* - type: string
* title: transaction_id
* description: The workflows execution's transaction id.
* description: Filter by a transaction ID.
* - type: array
* description: The workflows execution's transaction id.
* description: Filter by transaction IDs.
* items:
* type: string
* title: transaction_id
* description: The transaction id's details.
* description: A transaction ID.
* - name: workflow_id
* in: query
* required: false
@@ -68,13 +68,13 @@
* oneOf:
* - type: string
* title: workflow_id
* description: The workflows execution's workflow id.
* description: Filter by a workflow ID.
* - type: array
* description: The workflows execution's workflow id.
* description: Filter by workflow IDs.
* items:
* type: string
* title: workflow_id
* description: The workflow id's details.
* description: A workflow ID.
* security:
* - api_token: []
* - cookie_auth: []
@@ -95,7 +95,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of workflow executions.
* required:
* - limit
* - offset
@@ -104,17 +104,17 @@
* limit:
* type: number
* title: limit
* description: The workflows execution's limit.
* description: The maximum number of items returned.
* offset:
* type: number
* title: offset
* description: The workflows execution's offset.
* description: The number of items skipped before retrieving the returned items.
* count:
* type: number
* title: count
* description: The workflows execution's count.
* description: The total number of items.
* - type: object
* description: SUMMARY
* description: The paginated list of workflow executions.
* required:
* - workflow_executions
* properties:

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

@@ -1,8 +1,9 @@
/**
* @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id}
* operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id
* summary: "List "
* description: Retrieve a list of in a workflows execution. The can be filtered by fields like FILTER FIELDS. The can also be paginated.
* summary: Get Workflow Execution's Details
* x-sidebar-summary: Get Exection
* description: Get the details of the workflow's execution.
* x-authenticated: true
* parameters:
* - name: workflow_id

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

@@ -1,8 +1,12 @@
/**
* @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe
* operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe
* summary: List Subscribes
* description: Retrieve a list of subscribes in a workflows execution. The subscribes can be filtered by fields like FILTER FIELDS. The subscribes can also be paginated.
* summary: Subscribe to Step of a Workflow's Execution
* x-sidebar-summary: Subscribe to Step
* 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:
* - name: workflow_id
@@ -36,6 +40,14 @@
* tags:
* - Workflows Executions
* responses:
* "200":
* description: Stream of the step's status.
* content:
* text/event-stream:
* schema:
* type: string
* description: The step's status update and data changes.
* example: "event: success\n data: {}"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

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

@@ -1,8 +1,12 @@
/**
* @oas [get] /admin/workflows-executions/{workflow_id}/subscribe
* operationId: GetWorkflowsExecutionsWorkflow_idSubscribe
* summary: List Subscribes
* description: Retrieve a list of subscribes in a workflows execution. The subscribes can be filtered by fields like FILTER FIELDS. The subscribes can also be paginated.
* summary: Subscribe to a Workflow's Execution
* x-sidebar-summary: Subscribe to Workflow
* 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:
* - name: workflow_id
@@ -24,6 +28,14 @@
* tags:
* - Workflows Executions
* responses:
* "200":
* description: Stream of the step's status.
* content:
* text/event-stream:
* schema:
* type: string
* description: The step's status update and data changes.
* example: "event: success\n data: {}"
* "400":
* $ref: "#/components/responses/400_error"
* "401":

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

File diff suppressed because it is too large Load Diff

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

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