diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts index a12d23074e..02fd8e9be4 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts @@ -149,157 +149,225 @@ * description: The inventory item's requires shipping. * - name: weight * in: query - * description: The inventory item's weight. + * description: Filter the inventory item's weight. * required: false * schema: - * description: The inventory item's weight. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte + * description: Filter the inventory item's weight. * 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: length * in: query - * description: The inventory item's length. + * description: Filter the inventory item's length. * required: false * schema: - * description: The inventory item's length. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte + * description: Filter the inventory item's length. * 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: height * in: query - * description: The inventory item's height. + * description: Filter by the inventory item's height. * required: false * schema: - * description: The inventory item's height. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte + * description: Filter by the inventory item's height. * 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: width * in: query - * description: The inventory item's width. + * description: Filter by the inventory item's width. * required: false * schema: - * description: The inventory item's width. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte + * description: Filter by the inventory item's width. * 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: location_levels * in: query - * description: The inventory item's location levels. + * description: Filter by the inventory item's associated location IDs. * required: false * schema: * type: object - * description: The inventory item's location levels. + * description: Filter by the inventory item's associated location IDs. * properties: * location_id: * oneOf: * - type: string * title: location_id - * description: The location level's location id. + * description: The associated location's ID. * - type: array - * description: The location level's location id. + * description: The location IDs to retrieve inventory items associated with them. * items: * type: string * title: location_id - * description: The location id's details. + * description: A location's ID. * - name: $and * in: query * required: false * schema: * type: array - * description: The inventory item'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 @@ -308,7 +376,7 @@ * required: false * schema: * type: array - * description: The inventory item'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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts index b32af7bd00..c48a8f1489 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts @@ -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 invite's q. + * description: Search term to apply on an invite's searchable properties. * required: false * schema: * type: string * title: q - * description: The invite's q. + * description: Search term to apply on an invite's searchable properties. * - name: id * in: query * required: false @@ -62,13 +62,13 @@ * oneOf: * - type: string * title: id - * description: The invite's ID. + * description: Filter by an invite's ID. * - type: array - * description: The invite's ID. + * description: Filter by invite IDs. * items: * type: string * title: id - * description: The id's ID. + * description: An invite's ID. * - name: email * in: query * required: false @@ -76,36 +76,378 @@ * oneOf: * - type: string * title: email - * description: The invite's email. + * description: Filter by an invite's email. * format: email * - type: array - * description: The invite's email. + * description: Filter by invite emails. * items: * type: string * title: email - * description: The email's details. + * description: An email. * format: email * - name: created_at * in: query - * description: The invite's created at. + * description: Filter by the invite's creation date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the invite'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 invite's updated at. + * description: Filter by the invite's update date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the invite'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 invite's deleted at. + * description: Filter by the invite's deletion date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the invite'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 invite'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 invite'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 @@ -132,7 +474,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The paginated list of invites. * required: * - limit * - offset @@ -141,23 +483,23 @@ * limit: * type: number * title: limit - * description: The invite's limit. + * description: The maximum number of items retrieved. * offset: * type: number * title: offset - * description: The invite's offset. + * description: The number of items skipped before the returned items. * count: * type: number * title: count - * description: The invite's count. + * description: The total number of items. * - type: object - * description: SUMMARY + * description: The paginated list of invites. * required: * - invites * properties: * invites: * type: array - * description: The invite's invites. + * description: The list of invites. * items: * $ref: "#/components/schemas/AdminInvite" * "400": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts index 716b674739..fd11afd38f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts @@ -1,8 +1,8 @@ /** * @oas [get] /admin/invites/{id} * operationId: GetInvitesId - * summary: Get a Invite - * description: Retrieve a invite by its ID. You can expand the invite's relations or select the fields that should be returned. + * summary: Get an Invite + * description: Retrieve an invite by its ID. You can expand the invite's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts index 77447eeeab..d67f6b3cf9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts @@ -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 notification's q. + * description: Search term to apply on the notification's searchable properties. * required: false * schema: * type: string * title: q - * description: The notification's q. + * description: Search term to apply on the notification's searchable properties. * - name: id * in: query * required: false @@ -62,13 +62,13 @@ * oneOf: * - type: string * title: id - * description: The notification's ID. + * description: Filter by a notification ID. * - type: array - * description: The notification's ID. + * description: Filter by notification IDs. * items: * type: string * title: id - * description: The id's ID. + * description: A notification ID. * - name: channel * in: query * required: false @@ -76,19 +76,21 @@ * oneOf: * - type: string * title: channel - * description: The notification's channel. + * description: Filter by a notification channel. + * example: "email" * - type: array - * description: The notification's channel. + * description: Filter by notification channels. * items: * type: string * title: channel - * description: The channel's details. + * description: A notification channel. + * example: "email" * - name: $and * in: query * required: false * schema: * type: array - * description: The notification'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 +99,7 @@ * required: false * schema: * type: array - * description: The notification'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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts index bb0decd97a..391b512c34 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts @@ -47,6 +47,54 @@ * type: string * title: order * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: Filter by an order ID. + * - type: array + * description: Filter by order IDs. + * items: + * type: string + * title: id + * description: An order's ID. + * - name: status + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: status + * description: Filter by the order's status. + * - type: array + * description: Filter by order statuses. + * items: + * type: string + * title: status + * description: An order's status. + * - name: $and + * in: query + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * - name: $or + * in: query + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] @@ -67,7 +115,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The paginated list of orders * required: * - limit * - offset @@ -76,23 +124,23 @@ * limit: * type: number * title: limit - * description: The order's limit. + * description: The maximum number of items returned. * offset: * type: number * title: offset - * description: The order's offset. + * description: The number of items skipped before the returned items. * count: * type: number * title: count - * description: The order's count. + * description: The total count of items. * - type: object - * description: SUMMARY + * description: The paginated list of orders. * required: * - orders * properties: * orders: * type: array - * description: The order's orders. + * description: The list of orders. * items: * $ref: "#/components/schemas/AdminOrder" * "400": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts index 0e1aa1fe98..75634633f8 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts @@ -1,8 +1,8 @@ /** * @oas [get] /admin/orders/{id} * operationId: GetOrdersId - * summary: Get a Order - * description: Retrieve a order by its ID. You can expand the order's relations or select the fields that should be returned. + * summary: Get an Order + * description: Retrieve an order by its ID. You can expand the order's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts index c30d8e49cd..fe29ffcd16 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts @@ -1,8 +1,13 @@ /** * @oas [get] /admin/orders/{id}/changes * operationId: GetOrdersIdChanges - * summary: List Changes - * description: Retrieve a list of changes in a order. The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated. + * summary: List Changes on an Order + * x-sidebar-summary: List Changes + * description: > + * Retrieve a list of changes made on an order, including returns, exchanges, etc... + * + * + * The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts index efb47b19f0..be6ebdd698 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_preview.ts @@ -1,8 +1,8 @@ /** * @oas [get] /admin/orders/{id}/preview * operationId: GetOrdersIdPreview - * summary: List Previews - * description: Retrieve a list of previews in a order. The previews can be filtered by fields like FILTER FIELDS. The previews can also be paginated. + * summary: Get Preview + * description: Retrieve a preview of an order using its associated change, such as an edit. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts index c75bb4b493..c629aabe5e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts @@ -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 payment's q. + * description: Search term to filter the payment's searchable properties. * required: false * schema: * type: string * title: q - * description: The payment's q. + * description: Search term to filter the payment's searchable properties. * - name: id * in: query * required: false @@ -62,13 +62,13 @@ * oneOf: * - type: string * title: id - * description: The payment's ID. + * description: Filter by a payment ID. * - type: array - * description: The payment's ID. + * description: Filter by payment IDs. * items: * type: string * title: id - * description: The id's ID. + * description: A payment ID. * - name: payment_session_id * in: query * required: false @@ -76,34 +76,376 @@ * oneOf: * - type: string * title: payment_session_id - * description: The payment's payment session id. + * description: Filter by a payment session ID to retrieve its associated payments. * - type: array - * description: The payment's payment session id. + * description: Filter by payment session IDs to retrieve their associated payments. * items: * type: string * title: payment_session_id - * description: The payment session id's details. + * description: A payment session's ID. * - name: created_at * in: query - * description: The payment's created at. + * description: Filter by the payment's creation date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the payment'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 payment's updated at. + * description: Filter by the payment's update date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the payment'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 payment's deleted at. + * description: Filter by the payment's deletion date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the payment'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 payment'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 @@ -112,7 +454,7 @@ * required: false * schema: * type: array - * description: The payment'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 @@ -136,7 +478,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The paginated list of payments. * required: * - limit * - offset @@ -145,23 +487,23 @@ * limit: * type: number * title: limit - * description: The payment's limit. + * description: The maximum number of returned items. * offset: * type: number * title: offset - * description: The payment's offset. + * description: The number of items skipped before the returned items. * count: * type: number * title: count - * description: The payment's count. + * description: The total number of payments. * - type: object - * description: SUMMARY + * description: The paginated list of payments. * required: * - payments * properties: * payments: * type: array - * description: The payment's payments. + * description: The list of payments. * items: * $ref: "#/components/schemas/AdminPayment" * "400": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts index b92f467ad7..aee7c5a663 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts @@ -1,8 +1,8 @@ /** * @oas [get] /admin/payments/payment-providers * operationId: GetPaymentsPaymentProviders - * summary: List Payments - * description: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. + * summary: List Payment Providers + * description: Retrieve a list of payment providers. The payment providers can be filtered by fields such as `id`. The payment providers can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -54,27 +54,27 @@ * oneOf: * - type: string * title: id - * description: The payment's ID. + * description: Filter by a payment provider's ID. * - type: array - * description: The payment's ID. + * description: Filter by payment provider IDs. * items: * type: string * title: id - * description: The id's ID. + * description: A payment provider ID. * - name: is_enabled * in: query - * description: The payment's is enabled. + * description: Filter by whether the payment provider is enabled. * required: false * schema: * type: boolean * title: is_enabled - * description: The payment's is enabled. + * description: Filter by whether the payment provider is enabled. * - name: $and * in: query * required: false * schema: * type: array - * description: The payment'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 @@ -83,7 +83,7 @@ * required: false * schema: * type: array - * description: The payment'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 @@ -107,7 +107,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The list of payment providers. * required: * - limit * - offset @@ -116,23 +116,23 @@ * limit: * type: number * title: limit - * description: The payment's limit. + * description: The maximum number of items returned. * offset: * type: number * title: offset - * description: The payment's offset. + * description: The number of items skipped before the returned items. * count: * type: number * title: count - * description: The payment's count. + * description: The total number of items. * - type: object - * description: SUMMARY + * description: The paginated list of payment providers. * required: * - payment_providers * properties: * payment_providers: * type: array - * description: The payment's payment providers. + * description: The list of payment providers. * items: * $ref: "#/components/schemas/AdminPaymentProvider" * "400": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts index 577be9ce9f..28a3b5b888 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts @@ -47,6 +47,310 @@ * type: string * title: order * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * - name: q + * in: query + * description: Search term to filter the price list's searchable properties. + * required: false + * schema: + * type: string + * title: q + * description: Search term to filter the price list's searchable properties. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: Filter by a price list ID. + * - type: array + * description: Filter by price list IDs. + * items: + * type: string + * title: id + * description: A price list ID. + * - name: starts_at + * in: query + * description: Filter by a price list's start date. + * required: false + * schema: + * type: object + * description: Filter by a price list's start 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: ends_at + * in: query + * description: Filter by the price list's end date. + * required: false + * schema: + * type: object + * description: Filter by the price list's end 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: status + * in: query + * description: Filter by the price list's status. + * required: false + * schema: + * type: array + * description: Filter by the price list's status. + * items: + * type: string + * description: A price list's status. + * enum: + * - active + * - draft + * - name: rules_count + * in: query + * description: Filter by the price list's rules count. + * required: false + * schema: + * type: array + * description: Filter by the price list's rules count. + * items: + * type: number + * title: rules_count + * description: The price list's rule count. + * - name: $and + * in: query + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * - name: $or + * in: query + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts index b0610fdca7..18340a884c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts @@ -47,6 +47,76 @@ * type: string * title: order * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: Filter by a price preference ID. + * - type: array + * description: Filter by price preference IDs. + * items: + * type: string + * title: id + * description: A price preference ID. + * - name: attribute + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: attribute + * description: Filter by a price preference's attribute. + * - type: array + * description: Filter by price preference attributes. + * items: + * type: string + * title: attribute + * description: A price preference's attribute. + * - name: value + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: value + * description: Filter by a price preference's value. + * - type: array + * description: Filter by price preference values. + * items: + * type: string + * title: value + * description: A price preference's value. + * - name: q + * in: query + * description: Search term to apply on the price preference's searchable properties. + * required: false + * schema: + * type: string + * title: q + * description: Search term to apply on the price preference's searchable properties. + * - name: $and + * in: query + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * - name: $or + * in: query + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index 913d55b643..49890b5645 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -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 product category's q. + * description: Search term to filter on the product category's searchable properties. * required: false * schema: * type: string * title: q - * description: The product category's q. + * description: Search term to filter on the product category's searchable properties. * - name: id * in: query * required: false @@ -62,13 +62,13 @@ * oneOf: * - type: string * title: id - * description: The product category's ID. + * description: Filter by a product category's ID. * - type: array - * description: The product category's ID. + * description: Filter by product category IDs. * items: * type: string * title: id - * description: The id's ID. + * description: A product category ID. * - name: description * in: query * required: false @@ -76,13 +76,13 @@ * oneOf: * - type: string * title: description - * description: The product category's description. + * description: Filter by the category's description. This performs a full-text search. To do keyword search, use the `q` parameter instead. * - type: array - * description: The product category's description. + * description: Filter by category descriptions. This performs a full-text search. To do keyword search, use the `q` parameter instead. * items: * type: string * title: description - * description: The description's details. + * description: The category's description. * - name: handle * in: query * required: false @@ -90,13 +90,13 @@ * oneOf: * - type: string * title: handle - * description: The product category's handle. + * description: Filter by a category's handle. * - type: array - * description: The product category's handle. + * description: Filter by category handles. * items: * type: string * title: handle - * description: The handle's details. + * description: A category's handle. * - name: parent_category_id * in: query * required: false @@ -104,66 +104,408 @@ * oneOf: * - type: string * title: parent_category_id - * description: The product category's parent category id. + * description: Filter by a parent category's ID to retrieve its child categories. * - type: array - * description: The product category's parent category id. + * description: Filter by parent category IDs to retrieve their child categories. * items: * type: string * title: parent_category_id - * description: The parent category id's details. + * description: A parent category's ID. * - name: include_ancestors_tree * in: query - * description: The product category's include ancestors tree. + * description: Whether to include the parent category of each category. If enabled, the parent category is set in the `parent_category` property of each category object. * required: false * schema: * type: boolean * title: include_ancestors_tree - * description: The product category's include ancestors tree. + * description: Whether to include the parent category of each category. If enabled, the parent category is set in the `parent_category` property of each category object. * - name: include_descendants_tree * in: query - * description: The product category's include descendants tree. + * description: Whether to include the child categories of each category. If enabled, the child categories are added to the `category_children` property of each category object. * required: false * schema: * type: boolean * title: include_descendants_tree - * description: The product category's include descendants tree. + * description: Whether to include the child categories of each category. If enabled, the child categories are added to the `category_children` property of each category object. * - name: is_internal * in: query - * description: The product category's is internal. + * description: Filter by whether the category is internal. * required: false * schema: * type: boolean * title: is_internal - * description: The product category's is internal. + * description: Filter by whether the category is internal. * - name: is_active * in: query - * description: The product category's is active. + * description: Filter by whether the category is active. * required: false * schema: * type: boolean * title: is_active - * description: The product category's is active. + * description: Filter by whether the category is active. * - name: created_at * in: query - * description: The product category's created at. + * description: Filter by the category's creation date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the category'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 product category's updated at. + * description: Filter by the category's update date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the category'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 product category's deleted at. + * description: Filter by the category's deletion date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the category'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 product category'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 @@ -172,7 +514,7 @@ * required: false * schema: * type: array - * description: The product category'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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts index 459a4d33e4..c24c07f54b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts @@ -55,20 +55,20 @@ * 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: include_ancestors_tree * in: query - * description: The product category's include ancestors tree. + * description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. * required: false * schema: * type: boolean * title: include_ancestors_tree - * description: The product category's include ancestors tree. + * description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. * - name: include_descendants_tree * in: query - * description: The product category's include descendants tree. + * description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. * required: false * schema: * type: boolean * title: include_descendants_tree - * description: The product category's include descendants tree. + * description: Whether to retrieve a list of child categories. When enabled, the parent categories are added to the `category_children` property. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts index 8d8fe0ce54..ab39646b60 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts @@ -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 product tag's q. + * description: Search term to filter the product tag's searchable properties. * required: false * schema: * type: string * title: q - * description: The product tag's q. + * description: Search term to filter the product tag's searchable properties. * - name: id * in: query * required: false @@ -62,13 +62,13 @@ * oneOf: * - type: string * title: id - * description: The product tag's ID. + * description: Filter by a product tag's ID. * - type: array - * description: The product tag's ID. + * description: Filter by product tag IDs. * items: * type: string * title: id - * description: The id's ID. + * description: A product tag's ID. * - name: value * in: query * required: false @@ -76,34 +76,376 @@ * oneOf: * - type: string * title: value - * description: The product tag's value. + * description: Filter by a product tag's value. * - type: array - * description: The product tag's value. + * description: Filter by product tag values. * items: * type: string * title: value - * description: The value's details. + * description: A tag value. * - name: created_at * in: query - * description: The product tag's created at. + * description: Filter by the tag's creation date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the tag'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 product tag's updated at. + * description: Filter by the tag's update date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the tag'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 product tag's deleted at. + * description: Filter by the tag's deletion date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the tag'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 product tag'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 @@ -112,7 +454,7 @@ * required: false * schema: * type: array - * description: The product tag'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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts index 46ec0a3c2c..3e2ad297ed 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts @@ -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 product type's q. + * description: Search term to filter the product type's searchable properties. * required: false * schema: * type: string * title: q - * description: The product type's q. + * description: Search term to filter the product type's searchable properties. * - name: id * in: query * required: false @@ -62,13 +62,13 @@ * oneOf: * - type: string * title: id - * description: The product type's ID. + * description: Filter by a product type's ID. * - type: array - * description: The product type's ID. + * description: Filter by product type IDs. * items: * type: string * title: id - * description: The id's ID. + * description: A product type's ID. * - name: value * in: query * required: false @@ -76,34 +76,376 @@ * oneOf: * - type: string * title: value - * description: The product type's value. + * description: Filter by a type's value. * - type: array - * description: The product type's value. + * description: Filter by values. * items: * type: string * title: value - * description: The value's details. + * description: A type's value. * - name: created_at * in: query - * description: The product type's created at. + * description: Filter by the type's creation date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the type'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 product type's updated at. + * description: Filter by the type's update date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the type'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 product type's deleted at. + * description: Filter by the type's deletion date. * required: false - * schema: {} + * schema: + * type: object + * description: Filter by the type'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 product type'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 @@ -112,7 +454,7 @@ * required: false * schema: * type: array - * description: The product type'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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts index e2c3da1c2b..12f5e9044d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts @@ -47,6 +47,421 @@ * type: string * title: order * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * - name: q + * in: query + * description: Search term to filter the product variant's searchable properties. + * required: false + * schema: + * type: string + * title: q + * description: Search term to filter the product variant's searchable properties. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: Filter by a variant's ID. + * - type: array + * description: Filter by variant IDs. + * items: + * type: string + * title: id + * description: A variant's ID. + * - name: manage_inventory + * in: query + * description: Filter by whether a variant's `manage_inventory` is enabled. + * required: false + * schema: + * type: boolean + * title: manage_inventory + * description: Filter by whether a variant's `manage_inventory` is enabled. + * - name: allow_backorder + * in: query + * description: Filter by whether backorder is allowed for a variant. + * required: false + * schema: + * type: boolean + * title: allow_backorder + * description: Filter by whether backorder is allowed for a variant. + * - name: created_at + * in: query + * description: Filter by the product variant's creation date. + * required: false + * schema: + * type: object + * description: Filter by the product variant's creation date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by an exact match. + * items: + * type: string + * title: $eq + * description: Filter by an exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: updated_at + * in: query + * description: Filter by the product variant's update date. + * required: false + * schema: + * type: object + * description: Filter by the product variant's update date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by an exact match. + * items: + * type: string + * title: $eq + * description: Filter by an exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: deleted_at + * in: query + * description: Filter by the product variant's deletion date. + * required: false + * schema: + * type: object + * description: Filter by the product variant's deletion date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by an exact match. + * items: + * type: string + * title: $eq + * description: Filter by an exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: $and + * in: query + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * - name: $or + * in: query + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * required: false + * schema: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListListParams.ts b/www/utils/generated/oas-output/schemas/AdminPriceListListParams.ts new file mode 100644 index 0000000000..ef8e8c31df --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPriceListListParams.ts @@ -0,0 +1,522 @@ +/** + * @schema AdminPriceListListParams + * type: object + * description: SUMMARY + * x-schemaName: AdminPriceListListParams + * properties: + * q: + * type: string + * title: q + * description: The price list's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The price list's ID. + * - type: array + * description: The price list's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * starts_at: + * type: object + * description: The price list's starts at. + * properties: + * $and: + * type: array + * description: The starts at's $and. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: The starts at's $or. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by an exact match. + * items: + * type: string + * title: $eq + * description: Filter by an exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: The $not's $or. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by an exact match. + * items: + * type: string + * title: $eq + * description: Filter by an exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * ends_at: + * type: object + * description: The price list's ends at. + * properties: + * $and: + * type: array + * description: The ends at's $and. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: The ends at's $or. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by an exact match. + * items: + * type: string + * title: $eq + * description: Filter by an exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: The $not's $or. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by an exact match. + * items: + * type: string + * title: $eq + * description: Filter by an exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: Filter by values in this array. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: Filter by values not in this array. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching the conditions in this parameter. + * items: + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: Filter arrays that have overlapping values with this parameter. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: Filter arrays that contain some of the values of this parameter. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: Filter arrays that contain all values of this parameter. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * status: + * type: array + * description: The price list's status. + * items: + * type: string + * description: The status's details. + * enum: + * - active + * - draft + * rules_count: + * type: array + * description: The price list's rules count. + * items: + * type: number + * title: rules_count + * description: The rules count's details. + * limit: + * type: number + * title: limit + * description: The price list's limit. + * offset: + * type: number + * title: offset + * description: The price list's offset. + * order: + * type: string + * title: order + * description: The price list's order. + * fields: + * type: string + * title: fields + * description: The price list's fields. + * $and: + * type: array + * description: The price list's $and. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: The price list's $or. + * items: + * type: object + * title: $or + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPricePreferenceListParams.ts b/www/utils/generated/oas-output/schemas/AdminPricePreferenceListParams.ts new file mode 100644 index 0000000000..e3d3485b63 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPricePreferenceListParams.ts @@ -0,0 +1,74 @@ +/** + * @schema AdminPricePreferenceListParams + * type: object + * description: SUMMARY + * x-schemaName: AdminPricePreferenceListParams + * properties: + * id: + * oneOf: + * - type: string + * title: id + * description: The price preference's ID. + * - type: array + * description: The price preference's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * attribute: + * oneOf: + * - type: string + * title: attribute + * description: The price preference's attribute. + * - type: array + * description: The price preference's attribute. + * items: + * type: string + * title: attribute + * description: The attribute's details. + * value: + * oneOf: + * - type: string + * title: value + * description: The price preference's value. + * - type: array + * description: The price preference's value. + * items: + * type: string + * title: value + * description: The value's details. + * q: + * type: string + * title: q + * description: The price preference's q. + * limit: + * type: number + * title: limit + * description: The price preference's limit. + * offset: + * type: number + * title: offset + * description: The price preference's offset. + * order: + * type: string + * title: order + * description: The price preference's order. + * fields: + * type: string + * title: fields + * description: The price preference's fields. + * $and: + * type: array + * description: The price preference's $and. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: The price preference's $or. + * items: + * type: object + * title: $or + * +*/ +