diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh index a4fe7b1ab3..8f3ceaa879 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_items_{action_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh index 37f340cadb..37d6f9e1d7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_inbound_shipping-method_{action_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh index 2a9807a05f..f75dcd4918 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_items_{action_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh index 5114f4da82..500c6f14f5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_outbound_shipping-method_{action_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh index 05fc44f627..d5cfe4f60e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh index 6bcbee03da..9d54eda76b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_items_{action_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh index e84f1220f4..eb403de701 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_inbound_shipping-method_{action_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh index 8e718f5e4f..c960008db5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_items_{action_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh index 183e0bbdb4..3bd9fbbe29 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_exchanges_{id}_outbound_shipping-method_{action_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh index f694c5a87e..b2c98a2987 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh index d8ca96677f..a30ae85ec0 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_{location_id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ -H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_changes/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_changes/get.sh new file mode 100644 index 0000000000..32787df076 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_changes/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/orders/{id}/changes' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminApiKey.yaml new file mode 100644 index 0000000000..e51ff4c548 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminApiKey.yaml @@ -0,0 +1,60 @@ +type: object +description: The api key's details. +x-schemaName: AdminApiKey +required: + - id + - token + - redacted + - title + - type + - last_used_at + - created_by + - created_at + - revoked_by + - revoked_at +properties: + id: + type: string + title: id + description: The api key's ID. + token: + type: string + title: token + description: The api key's token. + redacted: + type: string + title: redacted + description: The api key's redacted. + title: + type: string + title: title + description: The api key's title. + type: + type: string + description: The api key's type. + enum: + - secret + - publishable + last_used_at: + type: string + title: last_used_at + description: The api key's last used at. + format: date-time + created_by: + type: string + title: created_by + description: The api key's created by. + created_at: + type: string + format: date-time + title: created_at + description: The api key's created at. + revoked_by: + type: string + title: revoked_by + description: The api key's revoked by. + revoked_at: + type: string + title: revoked_at + description: The api key's revoked at. + format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml index 7d07ea15a7..980051356d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminApiKeyResponse.yaml @@ -5,4 +5,4 @@ required: - api_key properties: api_key: - $ref: ./ApiKeyResponse.yaml + $ref: ./AdminApiKey.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductResponse.yaml index ed7d417345..697f688c90 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductResponse.yaml @@ -18,7 +18,7 @@ properties: $ref: ./AdminProduct.yaml deleted: type: object - description: The product's deleted. + description: SUMMARY required: - ids - object @@ -34,8 +34,8 @@ properties: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantResponse.yaml index 383fe37898..01dbaa3edd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantResponse.yaml @@ -18,7 +18,7 @@ properties: $ref: ./AdminProductVariant.yaml deleted: type: object - description: The product's deleted. + description: SUMMARY required: - ids - object @@ -34,8 +34,8 @@ properties: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCampaign.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCampaign.yaml new file mode 100644 index 0000000000..4b3d871f8a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCampaign.yaml @@ -0,0 +1,73 @@ +type: object +description: The campaign's details. +x-schemaName: AdminCampaign +required: + - id + - name + - description + - currency + - campaign_identifier + - starts_at + - ends_at + - budget +properties: + id: + type: string + title: id + description: The campaign's ID. + name: + type: string + title: name + description: The campaign's name. + description: + type: string + title: description + description: The campaign's description. + currency: + type: string + title: currency + description: The campaign's currency. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + budget: + type: object + description: The campaign's budget. + required: + - id + - type + - currency_code + - limit + - used + properties: + id: + type: string + title: id + description: The budget's ID. + type: + type: string + description: The budget's type. + enum: + - spend + - usage + currency_code: + type: string + title: currency_code + description: The budget's currency code. + limit: + type: number + title: limit + description: The budget's limit. + used: + type: number + title: used + description: The budget's used. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml index a7019974cb..60e666717f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCampaignResponse.yaml @@ -5,4 +5,4 @@ required: - campaign properties: campaign: - $ref: ./CampaignResponse.yaml + $ref: ./AdminCampaign.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml index 9eecf34368..c92a30e4e8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml @@ -113,6 +113,7 @@ properties: $ref: ./BasePaymentCollection.yaml payment_status: type: string + description: The claim's payment status. enum: - canceled - not_paid @@ -131,6 +132,7 @@ properties: $ref: ./BaseOrderFulfillment.yaml fulfillment_status: type: string + description: The claim's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml index 3ef16374d2..7262c162bf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The claim's object. + description: The name of the deleted object. default: claim deleted: type: boolean title: deleted - description: The claim's deleted. + description: Whether the Claim was deleted. parent: type: object description: The claim's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml index 7c95f2e8a3..8fb21f0636 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The collection's object. + description: The name of the deleted object. default: collection deleted: type: boolean title: deleted - description: The collection's deleted. + description: Whether the Collection was deleted. parent: type: object description: The collection's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApiKey.yaml index 1965ae3238..629c62ee00 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApiKey.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApiKey.yaml @@ -11,6 +11,7 @@ properties: description: The api key's title. type: type: string + description: The api key's type. enum: - publishable - secret diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml index bc76085c82..a8e62f3999 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml @@ -25,11 +25,13 @@ properties: description: The price list's ends at. status: type: string + description: The price list's status. enum: - active - draft type: type: string + description: The price list's type. enum: - sale - override diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml index 849d38df54..fac1377ff4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml @@ -47,6 +47,7 @@ properties: description: The create's handle. status: type: string + description: The create's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml index 969982fcb4..e10e753851 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml @@ -17,6 +17,7 @@ properties: compensate_input: {} action: type: string + description: The workflows execution's action. enum: - invoke - compensate diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml index 109a755674..d56f162420 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml @@ -114,6 +114,7 @@ properties: $ref: ./BasePaymentCollection.yaml payment_status: type: string + description: The exchange's payment status. enum: - canceled - not_paid @@ -132,6 +133,7 @@ properties: $ref: ./BaseOrderFulfillment.yaml fulfillment_status: type: string + description: The exchange's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml index e21a663cda..e8068b4b01 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The fulfillment set's object. + description: The name of the deleted object. default: fulfillment_set deleted: type: boolean title: deleted - description: The fulfillment set's deleted. + description: Whether the Fulfillment Set was deleted. parent: type: object description: The fulfillment set's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml index 5b81a094fc..f33a0a9aed 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInvite.yaml @@ -34,11 +34,11 @@ properties: description: The invite's metadata. created_at: type: string + format: date-time title: created_at description: The invite's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The invite's updated at. - format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml index 8ac3b682be..e26100a5de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -100,6 +100,7 @@ properties: $ref: ./BaseOrderShippingMethod.yaml payment_status: type: string + description: The order's payment status. enum: - canceled - not_paid @@ -113,6 +114,7 @@ properties: - requires_action fulfillment_status: type: string + description: The order's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangesResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangesResponse.yaml new file mode 100644 index 0000000000..4f8c9327af --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangesResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderChangesResponse +required: + - order_changes +properties: + order_changes: + type: array + description: The order's order changes. + items: + $ref: ./BaseOrderChange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml index 4b3f9af0d3..b7b508bb87 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -200,14 +200,14 @@ properties: $ref: ./BaseOrderItemDetail.yaml created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -505,6 +505,7 @@ properties: $ref: ./AdminPaymentCollection.yaml payment_status: type: string + description: The order preview's payment status. enum: - canceled - not_paid @@ -523,6 +524,7 @@ properties: $ref: ./BaseOrderFulfillment.yaml fulfillment_status: type: string + description: The order preview's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml index e58397669a..684b9497bb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml @@ -93,6 +93,7 @@ properties: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml index 537c8a371a..bd2b3450cc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml @@ -22,6 +22,7 @@ properties: description: The item's quantity. reason: type: string + description: The item's reason. enum: - missing_item - wrong_item diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml index 2dbe34cae5..0a3dcc4f9c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -9,6 +9,7 @@ required: properties: type: type: string + description: The claim's type. enum: - refund - replace diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml index ff8ed0bc50..e921b8aa5f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceList.yaml @@ -40,11 +40,13 @@ properties: description: The price list's ends at. status: type: string + description: The price list's status. enum: - draft - active type: type: string + description: The price list's type. enum: - sale - override diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml index f525939ed7..b4cb20eabd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListBatchResponse.yaml @@ -18,7 +18,7 @@ properties: $ref: ./AdminPrice.yaml deleted: type: object - description: The price list's deleted. + description: SUMMARY required: - ids - object @@ -34,8 +34,8 @@ properties: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml index 9fc53869c3..310a95819b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The price list's object. + description: The name of the deleted object. default: price_list deleted: type: boolean title: deleted - description: The price list's deleted. + description: Whether the Price List was deleted. parent: type: object description: The price list's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml index a34e982325..88ad9e74bf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPricePreferenceDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The price preference's object. + description: The name of the deleted object. default: price_preference deleted: type: boolean title: deleted - description: The price preference's deleted. + description: Whether the Price Preference was deleted. parent: type: object description: The price preference's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml index f31c9d51d9..fd29fa661a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -47,7 +47,7 @@ properties: items: $ref: ./AdminProductVariant.yaml type: - type: object + $ref: ./AdminProductType.yaml tags: type: array description: The parent's tags. @@ -59,6 +59,7 @@ properties: description: The parent's title. status: type: string + description: The parent's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml index 750ab66be6..1845f1e5de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml @@ -40,6 +40,9 @@ properties: type: string title: id description: The category's ID. + metadata: + type: object + description: The category's metadata. created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml index 38c8ca528b..bbccf4934a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The product category's object. + description: The name of the deleted object. default: product_category deleted: type: boolean title: deleted - description: The product category's deleted. + description: Whether the Product Category was deleted. parent: type: object description: The product category's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml index 65b2edf6c2..e254c15d68 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: product deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: type: object description: The product's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml index c67be976b3..d3f1b213af 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml @@ -13,11 +13,11 @@ properties: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: product_option deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml index d723c20219..5304b49c5b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The product tag's object. + description: The name of the deleted object. default: product_tag deleted: type: boolean title: deleted - description: The product tag's deleted. + description: Whether the Product Tag was deleted. parent: type: object description: The product tag's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml new file mode 100644 index 0000000000..a8d58344ea --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml @@ -0,0 +1,35 @@ +type: object +description: The parent's type. +x-schemaName: AdminProductType +required: + - id + - value + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The type's ID. + value: + type: string + title: value + description: The type's value. + created_at: + type: string + format: date-time + title: created_at + description: The type's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The type's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The type's deleted at. + metadata: + type: object + description: The type's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml index dcd995552c..faa54a3337 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The product type's object. + description: The name of the deleted object. default: product_type deleted: type: boolean title: deleted - description: The product type's deleted. + description: Whether the Product Type was deleted. parent: type: object description: The product type's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml index 5e6dfa5a8f..9bf9f9159f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml @@ -23,4 +23,4 @@ properties: type: array description: The product type's product types. items: - $ref: ./AdminProduct.yaml + $ref: ./AdminProductType.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml index 3e74c8b2fb..8daf16a292 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml @@ -5,4 +5,4 @@ required: - product_type properties: product_type: - $ref: ./AdminProduct.yaml + $ref: ./AdminProductType.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml index dc3b12dd34..7663cc2969 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml @@ -13,11 +13,11 @@ properties: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: variant deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml index 3da518f03a..9cf2e1c985 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml @@ -76,10 +76,10 @@ properties: oneOf: - $ref: ./AdminProductVariantInventoryLink.yaml - type: array - description: The product's deleted. + description: SUMMARY items: type: object - description: The deleted's details. + description: SUMMARY x-schemaName: AdminProductVariantInventoryLink required: - productService diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml index 4e2fdc8918..ba2ab976f9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml @@ -12,10 +12,10 @@ properties: object: type: string title: object - description: The product's object. + description: The name of the deleted object. deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: ./AdminProductVariant.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml index 0b6f5fd615..9aca47220c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml @@ -62,17 +62,11 @@ properties: type: array description: The variant's $and. items: - type: array - description: The $and's details. - items: - type: object - title: $and + type: object + title: $and $or: type: array description: The variant's $or. items: - type: array - description: The $or's details. - items: - type: object - title: $or + type: object + title: $or diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml index a04db87818..2a31b4ded7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml @@ -14,6 +14,7 @@ properties: description: The promotion's code. type: type: string + description: The promotion's type. enum: - standard - buyget @@ -33,4 +34,4 @@ properties: title: campaign_id description: The promotion's campaign id. campaign: - $ref: ./CampaignResponse.yaml + $ref: ./AdminCampaign.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml index 606b760d6f..010bb3dc39 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml @@ -19,6 +19,7 @@ properties: description: The updated's attribute. operator: type: string + description: The updated's operator. enum: - gt - lt diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml new file mode 100644 index 0000000000..29f54068a7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml @@ -0,0 +1,66 @@ +type: object +description: The reservation's details. +x-schemaName: AdminReservation +required: + - id + - line_item_id + - location_id + - quantity + - external_id + - description + - inventory_item_id + - inventory_item +properties: + id: + type: string + title: id + description: The reservation's ID. + line_item_id: + type: string + title: line_item_id + description: The reservation's line item id. + location_id: + type: string + title: location_id + description: The reservation's location id. + quantity: + type: string + title: quantity + description: The reservation's quantity. + external_id: + type: string + title: external_id + description: The reservation's external id. + description: + type: string + title: description + description: The reservation's description. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + inventory_item: + type: object + description: The reservation's inventory item. + metadata: + type: object + description: The reservation's metadata. + created_by: + type: string + title: created_by + description: The reservation's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The reservation's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The reservation's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The reservation's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml index 6f13a6c0e5..42075fd8ac 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml @@ -5,4 +5,4 @@ required: - reservation properties: reservation: - $ref: ./ReservationResponse.yaml + $ref: ./AdminReservation.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml index f35a98e0a3..0ef197d0f7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml @@ -9,6 +9,7 @@ required: - items - received_at - created_at + - canceled_at properties: id: type: string @@ -64,3 +65,7 @@ properties: format: date-time title: created_at description: The return's created at. + canceled_at: + type: string + title: canceled_at + description: The return's canceled at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml index 104e37834a..47cbe93e16 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml @@ -5,6 +5,7 @@ required: - id - quantity - received_quantity + - damaged_quantity - item_id - return_id properties: @@ -20,6 +21,10 @@ properties: type: number title: received_quantity description: The return item's received quantity. + damaged_quantity: + type: number + title: damaged_quantity + description: The return item's damaged quantity. reason_id: type: string title: reason_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml index 56dff1a392..d4e8756457 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The sales channel's object. + description: The name of the deleted object. default: sales-channel deleted: type: boolean title: deleted - description: The sales channel's deleted. + description: Whether the Sales Channel was deleted. parent: type: object description: The sales channel's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml index 4581ba2a6a..fb43eb3166 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The shipping option's object. + description: The name of the deleted object. default: shipping_option deleted: type: boolean title: deleted - description: The shipping option's deleted. + description: Whether the Shipping Option was deleted. parent: type: object description: The shipping option's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml index edbadf9d4d..426860c955 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The shipping profile's object. + description: The name of the deleted object. default: shipping_profile deleted: type: boolean title: deleted - description: The shipping profile's deleted. + description: Whether the Shipping Profile was deleted. parent: type: object description: The shipping profile's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml index eded6905fb..f3250de0ed 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The stock location's object. + description: The name of the deleted object. default: stock_location deleted: type: boolean title: deleted - description: The stock location's deleted. + description: Whether the Stock Location was deleted. parent: type: object description: The stock location's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml index 8d63342ef2..aa496ab053 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The tax rate's object. + description: The name of the deleted object. default: tax_rate deleted: type: boolean title: deleted - description: The tax rate's deleted. + description: Whether the Tax Rate was deleted. parent: type: object description: The tax rate's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml index fcc06bd342..4e2ac8feb4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The tax region's object. + description: The name of the deleted object. default: tax_region deleted: type: boolean title: deleted - description: The tax region's deleted. + description: Whether the Tax Region was deleted. parent: type: object description: The tax region's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml index f6929dd104..464f157c82 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml @@ -24,11 +24,13 @@ properties: description: The price list's ends at. status: type: string + description: The price list's status. enum: - active - draft type: type: string + description: The price list's type. enum: - sale - override diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml index c5e1c3c7a9..844455161e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml @@ -45,6 +45,7 @@ properties: description: The update's handle. status: type: string + description: The update's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml index 5714e8f25d..eb3c002ae6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The user's object. + description: The name of the deleted object. default: user deleted: type: boolean title: deleted - description: The user's deleted. + description: Whether the User was deleted. parent: type: object description: The user's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml index 8e71182f9e..1c803655b9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml @@ -10,7 +10,6 @@ required: - state - created_at - updated_at - - deleted_at properties: id: type: string @@ -25,26 +24,32 @@ properties: title: transaction_id description: The workflow execution's transaction id. execution: - type: string - title: execution - description: The workflow execution's execution. + $ref: ./AdminWorkflowExecutionExecution.yaml context: + $ref: ./WorkflowExecutionContext.yaml + state: type: string - title: context - description: The workflow execution's context. - state: {} + description: The workflow execution's state. + enum: + - not_started + - invoking + - waiting_to_compensate + - compensating + - done + - reverted + - failed created_at: type: string + format: date-time title: created_at description: The workflow execution's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The workflow execution's updated at. - format: date-time deleted_at: type: string + format: date-time title: deleted_at description: The workflow execution's deleted at. - format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml new file mode 100644 index 0000000000..e589756af2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml @@ -0,0 +1,9 @@ +type: object +description: The workflow execution's execution. +x-schemaName: AdminWorkflowExecutionExecution +required: + - steps +properties: + steps: + type: object + description: The execution's steps. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml index b45304e208..4e1e727e4a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml @@ -10,17 +10,20 @@ properties: description: The application method's ID. type: type: string + description: The application method's type. enum: - fixed - percentage target_type: type: string + description: The application method's target type. enum: - items - shipping_methods - order allocation: type: string + description: The application method's allocation. enum: - each - across diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml index c1a1fc38f4..01d9216030 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml @@ -159,19 +159,19 @@ properties: description: The item's metadata. created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time deleted_at: type: string + format: date-time title: deleted_at description: The item's deleted at. - format: date-time original_total: oneOf: - type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml index bff97378cc..27c9efe996 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml @@ -32,6 +32,7 @@ properties: description: The claim item's quantity. reason: type: string + description: The claim item's reason. enum: - missing_item - wrong_item diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml index ee7a005d9c..dc086f2f8e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml @@ -119,6 +119,7 @@ properties: description: The order change's version. change_type: type: string + description: The order change's change type. enum: - return - exchange diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml index 3e6cbb2a1a..513f2f9f6a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml @@ -59,11 +59,11 @@ properties: description: The fulfillment's metadata. created_at: type: string + format: date-time title: created_at description: The fulfillment's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The fulfillment's updated at. - format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml index e3808ee206..ecf54b1785 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml @@ -146,14 +146,14 @@ properties: $ref: ./BaseOrderItemDetail.yaml created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml index f60bcd7273..309583af20 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml @@ -93,6 +93,7 @@ properties: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml index bb621de314..c07bd8c599 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml @@ -55,6 +55,7 @@ properties: description: The product's is giftcard. status: type: string + description: The product's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml index 29325b0a3b..26a4b19afb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRule.yaml @@ -19,6 +19,7 @@ properties: description: The rule's attribute. operator: type: string + description: The rule's operator. enum: - gt - lt diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml index a414e29765..e4b9f03dab 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml @@ -37,6 +37,7 @@ properties: description: The order change's version. change_type: type: string + description: The order change's change type. enum: - return - exchange diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml index ed4f9667c0..b51f369920 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml @@ -212,14 +212,14 @@ properties: $ref: ./OrderItem.yaml created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -659,6 +659,7 @@ properties: x-schemaName: OrderChangeAction status: type: string + description: The order preview's status. enum: - canceled - requires_action diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml new file mode 100644 index 0000000000..af376781b2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml @@ -0,0 +1,77 @@ +type: object +description: The cart's billing address. +x-schemaName: StoreCartAddress +required: + - id + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + oneOf: + - type: string + title: created_at + description: The billing address's created at. + - type: string + title: created_at + description: The billing address's created at. + format: date-time + updated_at: + oneOf: + - type: string + title: updated_at + description: The billing address's updated at. + - type: string + title: updated_at + description: The billing address's updated at. + format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml new file mode 100644 index 0000000000..1b92e40ec6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml @@ -0,0 +1,306 @@ +type: object +description: The item's items. +x-schemaName: StoreCartLineItem +required: + - id + - title + - quantity + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - cart + - cart_id + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + quantity: + oneOf: + - type: string + title: quantity + description: The item's quantity. + - type: number + title: quantity + description: The item's quantity. + - type: string + title: quantity + description: The item's quantity. + - $ref: ./IBigNumber.yaml + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant: + $ref: ./BaseProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The item's variant id. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + oneOf: + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - type: number + title: compare_at_unit_price + description: The item's compare at unit price. + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - $ref: ./IBigNumber.yaml + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: string + title: unit_price + description: The item's unit price. + - $ref: ./IBigNumber.yaml + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./BaseLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./BaseLineItemAdjustment.yaml + cart: + $ref: ./BaseCart.yaml + cart_id: + type: string + title: cart_id + description: The item's cart id. + metadata: + type: object + description: The item's metadata. + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The item's deleted at. + format: date-time + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml index 38c9d30978..da0096fa7a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -94,6 +94,7 @@ properties: $ref: ./BasePaymentCollection.yaml payment_status: type: string + description: The order's payment status. enum: - canceled - not_paid @@ -112,6 +113,7 @@ properties: $ref: ./BaseOrderFulfillment.yaml fulfillment_status: type: string + description: The order's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml index d19be961a8..94658ceb27 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml @@ -93,6 +93,7 @@ properties: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml index 8f607cc98a..42d6393938 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -42,6 +42,7 @@ properties: description: The product's title. status: type: string + description: The product's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml index 6614848161..d164aa2e9c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml @@ -60,6 +60,9 @@ properties: description: The category's category children. items: $ref: ./BaseProductCategory.yaml + metadata: + type: object + description: The category's metadata. created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml index a707c05720..4f35c16688 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml @@ -9,6 +9,7 @@ required: - items - received_at - created_at + - canceled_at properties: id: type: string @@ -64,3 +65,7 @@ properties: format: date-time title: created_at description: The return's created at. + canceled_at: + type: string + title: canceled_at + description: The return's canceled at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml index 4d8cc26173..13a1160363 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml @@ -26,6 +26,7 @@ properties: description: The shipping option's name. price_type: type: string + description: The shipping option's price type. enum: - flat - calculated diff --git a/www/apps/api-reference/specs/admin/components/schemas/WorkflowExecutionContext.yaml b/www/apps/api-reference/specs/admin/components/schemas/WorkflowExecutionContext.yaml new file mode 100644 index 0000000000..2d20174121 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/WorkflowExecutionContext.yaml @@ -0,0 +1,19 @@ +type: object +description: The workflow execution's context. +x-schemaName: WorkflowExecutionContext +required: + - compensate + - errors +properties: + data: + type: object + description: The context's data. + compensate: + type: object + description: The context's compensate. + errors: + type: array + description: The context's errors. + items: + type: object + description: The error's errors. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 50a49418e0..e652d02670 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -9,12 +9,6 @@ servers: - url: http://localhost:9000 - url: https://api.medusajs.com tags: - - name: Auth - description: | - Auth API routes allow you to manage an admin user's authentication. - externalDocs: - description: Learn more about the Auth Module - url: https://docs.medusajs.com/v2/resources/commerce-modules/auth - name: Api Keys description: | API keys can be used for authentication or resource-scoping. @@ -25,6 +19,8 @@ tags: externalDocs: description: Learn more about the API Key Module url: https://docs.medusajs.com/v2/resources/commerce-modules/api-key + x-associatedSchema: + $ref: '#/components/schemas/AdminApiKey' - name: Campaigns description: | A campaign is a group of promotions that have the same conditions, such as start and end dates. @@ -33,6 +29,8 @@ tags: externalDocs: description: Learn more about campaigns. url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/campaign + x-associatedSchema: + $ref: '#/components/schemas/AdminCampaign' - name: Claims description: | An admin creates a claim for an order when a customer reports that an item is defective or incorrect. @@ -90,8 +88,6 @@ tags: externalDocs: description: Learn more about the Order Module url: https://docs.medusajs.com/v2/resources/commerce-modules/order - x-associatedSchema: - $ref: '#/components/schemas/AdminOrder' - name: Exchanges description: | An exchange is the replacement of an item that the customer ordered with another. @@ -173,8 +169,6 @@ tags: externalDocs: description: Learn more about the Order Module url: https://docs.medusajs.com/v2/resources/commerce-modules/order - x-associatedSchema: - $ref: '#/components/schemas/OrderChange' - name: Orders description: | An order is a purchase made by a customer through a storefront. @@ -269,6 +263,8 @@ tags: externalDocs: description: Learn more about the Product Module url: https://docs.medusajs.com/v2/resources/commerce-modules/product + x-associatedSchema: + $ref: '#/components/schemas/AdminProductType' - name: Product Variants description: | A product variant is a saleable form of the product. @@ -338,6 +334,8 @@ tags: externalDocs: description: Learn more about reservations and other inventory concepts. url: https://docs.medusajs.com/v2/resources/commerce-modules/inventory/concepts + x-associatedSchema: + $ref: '#/components/schemas/AdminReservation' - name: Return Reasons description: | A return reason is a possible reason that an item is returned from the customer, such as when returning an item. @@ -449,8 +447,6 @@ tags: externalDocs: description: Check out available file module providers. url: https://docs.medusajs.com/v2/resources/architectural-modules/file - x-associatedSchema: - $ref: '#/components/schemas/AdminFile' - name: Users description: | A user is an admin user that can authenticate and perform functionalities as an admin user. @@ -471,8 +467,6 @@ tags: externalDocs: description: Check out available Workflow Engine Modules url: https://docs.medusajs.com/v2/resources/architectural-modules/workflow-engine - x-associatedSchema: - $ref: '#/components/schemas/AdminWorkflowExecution' paths: /admin/api-keys: get: @@ -586,47 +580,7 @@ paths: summary: Create Api Key description: Create a api key. x-authenticated: true - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] security: - api_token: [] - cookie_auth: [] @@ -845,58 +799,20 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateApiKeysWorkflow delete: operationId: DeleteApiKeysId - summary: Delete a Api Key - description: Delete a api key. + summary: Delete an Api Key + description: | + Delete a publishable or secret API key. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -925,18 +841,19 @@ paths: id: type: string title: id - description: The api key's ID. + description: The API key's ID. object: type: string title: object - description: The api key's object. + description: The name of the object that was deleted. + default: api_key deleted: type: boolean title: deleted - description: The api key's deleted. + description: Whether the API key was deleted. parent: type: object - description: The api key's parent. + description: The API key's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -949,6 +866,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteApiKeysWorkflow /admin/api-keys/{id}/revoke: post: operationId: PostApiKeysIdRevoke @@ -1038,6 +956,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: revokeApiKeysWorkflow /admin/api-keys/{id}/sales-channels: post: operationId: PostApiKeysIdSalesChannels @@ -1143,6 +1062,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: linkSalesChannelsToApiKeyWorkflow /admin/campaigns: get: operationId: GetCampaigns @@ -1413,6 +1333,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createCampaignsWorkflow /admin/campaigns/{id}: get: operationId: GetCampaignsId @@ -1650,10 +1571,12 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCampaignsWorkflow delete: operationId: DeleteCampaignsId summary: Delete a Campaign - description: Delete a campaign. + description: | + Delete a campaign by its ID. This doesn't delete promotions that belong to this campaign. x-authenticated: true parameters: - name: id @@ -1662,46 +1585,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -1734,11 +1617,12 @@ paths: object: type: string title: object - description: The campaign's object. + description: The name of the object that was deleted. + default: campaign deleted: type: boolean title: deleted - description: The campaign's deleted. + description: Whether the campaign was deleted. parent: type: object description: The campaign's parent. @@ -1754,6 +1638,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteCampaignsWorkflow /admin/campaigns/{id}/promotions: post: operationId: PostCampaignsIdPromotions @@ -1859,6 +1744,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: addOrRemoveCampaignPromotionsWorkflow /admin/claims: get: operationId: GetClaims @@ -2025,6 +1911,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: beginClaimOrderWorkflow /admin/claims/{id}: get: operationId: GetClaimsId @@ -2122,46 +2009,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -2198,6 +2045,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelOrderClaimWorkflow /admin/claims/{id}/claim-items: post: operationId: PostClaimsIdClaimItems @@ -2386,8 +2234,12 @@ paths: x-workflow: updateClaimItemWorkflow delete: operationId: DeleteClaimsIdClaimItemsAction_id - summary: Remove Claim Items from Claim - description: Remove a list of claim items from a claim. This doesn't delete the Claim Item, only the association between the Claim Item and the claim. + summary: Remove a Claim Item from a Claim + x-sidebar-summary: Remove Claim Item + description: | + Remove an order item from a claim by the ID of the item's `WRITE_OFF_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -2398,7 +2250,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the order item's `WRITE_OFF_ITEM` action. required: true schema: type: string @@ -2487,46 +2339,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -2583,46 +2395,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -2662,8 +2434,12 @@ paths: x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteClaimsIdInboundItemsAction_id - summary: Remove Items from Claim - description: Remove a list of items from a claim. This doesn't delete the Item, only the association between the Item and the claim. + summary: Remove an Inbound Item from Claim + x-sidebar-summary: Remove Inbound Item + description: | + Remove an inbound (or return) item from a claim using the `ID` of the item's `RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -2674,7 +2450,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the return item's `RETURN_ITEM` action. required: true schema: type: string @@ -2725,9 +2501,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/inbound/items/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Claims responses: @@ -2763,46 +2537,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -2942,8 +2676,12 @@ paths: x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteClaimsIdInboundShippingMethodAction_id - summary: Remove Shipping Methods from Claim - description: Remove a list of shipping methods from a claim. This doesn't delete the Shipping Method, only the association between the Shipping Method and the claim. + summary: Remove Inbound Shipping Method from Claim + x-sidebar-summary: Remove Inbound Shipping Method + description: | + Remove the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -2954,50 +2692,10 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -3005,9 +2703,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Claims responses: @@ -3218,8 +2914,12 @@ paths: x-workflow: updateClaimAddItemWorkflow delete: operationId: DeleteClaimsIdOutboundItemsAction_id - summary: Remove Items from Claim - description: Remove a list of items from a claim. This doesn't delete the Item, only the association between the Item and the claim. + summary: Remove an Outbound Item from Claim + x-sidebar-summary: Remove Outbound Item + description: | + Remove an outbound (or new) item from a claim using the `ID` of the item's `ITEM_ADD` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -3230,7 +2930,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the new claim item's `ITEM_ADD` action. required: true schema: type: string @@ -3281,9 +2981,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/outbound/items/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Claims responses: @@ -3498,8 +3196,12 @@ paths: x-workflow: updateClaimShippingMethodWorkflow delete: operationId: DeleteClaimsIdOutboundShippingMethodAction_id - summary: Remove Shipping Methods from Claim - description: Remove a list of shipping methods from a claim. This doesn't delete the Shipping Method, only the association between the Shipping Method and the claim. + summary: Remove Outbound Shipping Method from Claim + x-sidebar-summary: Remove Outbound Shipping Method + description: | + Remove the shipping method for delivering outbound items in the claim using the `ID` of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -3510,7 +3212,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -3561,9 +3263,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Claims responses: @@ -3677,8 +3377,8 @@ paths: x-workflow: confirmClaimRequestWorkflow delete: operationId: DeleteClaimsIdRequest - summary: Remove Requests from Claim - description: Remove a list of requests from a claim. This doesn't delete the Request, only the association between the Request and the claim. + summary: Cancel Claim Request + description: Cancel a requested claim. x-authenticated: true parameters: - name: id @@ -3687,46 +3387,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -3758,6 +3418,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelBeginOrderClaimWorkflow /admin/collections: get: operationId: GetCollections @@ -4100,10 +3761,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCollectionsWorkflow delete: operationId: DeleteCollectionsId summary: Delete a Collection - description: Delete a collection. + description: Delete a product collection. x-authenticated: true parameters: - name: id @@ -4112,46 +3774,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -4183,6 +3805,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteCollectionsWorkflow /admin/collections/{id}/products: post: operationId: PostCollectionsIdProducts @@ -4288,6 +3911,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchLinkProductsToCollectionWorkflow /admin/currencies: get: operationId: GetCurrencies @@ -4644,6 +4268,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createCustomerGroupsWorkflow /admin/customer-groups/{id}: get: operationId: GetCustomerGroupsId @@ -4821,10 +4446,12 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCustomerGroupsWorkflow delete: operationId: DeleteCustomerGroupsId summary: Delete a Customer Group - description: Delete a customer group. + description: | + Delete a customer group. Customers in the group aren't deleted. x-authenticated: true parameters: - name: id @@ -4833,46 +4460,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -4925,6 +4512,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteCustomerGroupsWorkflow /admin/customer-groups/{id}/customers: post: operationId: PostCustomerGroupsIdCustomers @@ -5030,6 +4618,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: linkCustomersToCustomerGroupWorkflow /admin/customers: get: operationId: GetCustomers @@ -5266,6 +4855,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createCustomersWorkflow /admin/customers/{id}: get: operationId: GetCustomersId @@ -5488,6 +5078,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCustomersWorkflow delete: operationId: DeleteCustomersId summary: Delete a Customer @@ -5500,46 +5091,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -5592,6 +5143,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteCustomersWorkflow /admin/customers/{id}/addresses: get: operationId: GetCustomersIdAddresses @@ -5886,6 +5438,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createCustomerAddressesWorkflow /admin/customers/{id}/addresses/{address_id}: get: operationId: GetCustomersIdAddressesAddress_id @@ -6163,10 +5716,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCustomerAddressesWorkflow delete: operationId: DeleteCustomersIdAddressesAddress_id - summary: Remove Addresses from Customer - description: Remove a list of addresses from a customer. This doesn't delete the Address, only the association between the Address and the customer. + summary: Remove an Address from Customer + description: Remove a customer's address. x-authenticated: true parameters: - name: id @@ -6177,7 +5731,7 @@ paths: type: string - name: address_id in: path - description: The customer's address id. + description: The customer address's ID. required: true schema: type: string @@ -6228,9 +5782,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/customers/{id}/addresses/{address_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Customers responses: @@ -6273,6 +5825,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteCustomerAddressesWorkflow /admin/draft-orders: get: operationId: GetDraftOrders @@ -6779,46 +6332,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -7041,6 +6554,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: beginExchangeOrderWorkflow /admin/exchanges/{id}: get: operationId: GetExchangesId @@ -7138,46 +6652,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -7214,6 +6688,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelOrderExchangeWorkflow /admin/exchanges/{id}/inbound/items: post: operationId: PostExchangesIdInboundItems @@ -7227,46 +6702,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -7323,46 +6758,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -7402,8 +6797,12 @@ paths: x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteExchangesIdInboundItemsAction_id - summary: Remove Items from Exchange - description: Remove a list of items from a exchange. This doesn't delete the Item, only the association between the Item and the exchange. + summary: Remove Inbound Item from Exchange + x-sidebar-summary: Remove Inbound Item + description: | + Remove an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -7414,7 +6813,7 @@ paths: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the return item's `RETURN_ITEM` action. required: true schema: type: string @@ -7465,9 +6864,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Exchanges responses: @@ -7503,46 +6900,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -7682,8 +7039,12 @@ paths: x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteExchangesIdInboundShippingMethodAction_id - summary: Remove Shipping Methods from Exchange - description: Remove a list of shipping methods from a exchange. This doesn't delete the Shipping Method, only the association between the Shipping Method and the exchange. + summary: Remove Inbound Shipping Method from Exchange + x-sidebar-summary: Remove Inbound Shipping Method + description: | + Remove the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -7694,50 +7055,10 @@ paths: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -7745,9 +7066,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Exchanges responses: @@ -7958,8 +7277,12 @@ paths: x-workflow: updateExchangeAddItemWorkflow delete: operationId: DeleteExchangesIdOutboundItemsAction_id - summary: Remove Items from Exchange - description: Remove a list of items from a exchange. This doesn't delete the Item, only the association between the Item and the exchange. + summary: Remove Outbound Item from Exchange + x-sidebar-summary: Remove Outbound Item + description: | + Remove an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -7970,7 +7293,7 @@ paths: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the new exchange item's `ITEM_ADD` action. required: true schema: type: string @@ -8021,9 +7344,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Exchanges responses: @@ -8238,8 +7559,12 @@ paths: x-workflow: updateExchangeShippingMethodWorkflow delete: operationId: DeleteExchangesIdOutboundShippingMethodAction_id - summary: Remove Shipping Methods from Exchange - description: Remove a list of shipping methods from a exchange. This doesn't delete the Shipping Method, only the association between the Shipping Method and the exchange. + summary: Remove Outbound Shipping Method from Exchange + x-sidebar-summary: Remove Outbound Shipping Method + description: | + Remove the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -8250,7 +7575,7 @@ paths: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -8301,9 +7626,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}''\ -H ''x-medusa-access-token: {api_token}''' tags: - Exchanges responses: @@ -8417,8 +7740,8 @@ paths: schema: {} delete: operationId: DeleteExchangesIdRequest - summary: Remove Requests from Exchange - description: Remove a list of requests from a exchange. This doesn't delete the Request, only the association between the Request and the exchange. + summary: Cancel Exchange Request + description: Cancel a requested exchange. x-authenticated: true parameters: - name: id @@ -8427,46 +7750,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -8499,11 +7782,12 @@ paths: object: type: string title: object - description: The exchange's object. + description: The name of the deleted object. + default: exchange deleted: type: boolean title: deleted - description: The exchange's deleted. + description: Whether the exchange was deleted. parent: type: object description: The exchange's parent. @@ -8519,6 +7803,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelBeginOrderExchangeWorkflow /admin/fulfillment-providers: get: operationId: GetFulfillmentProviders @@ -8583,7 +7868,7 @@ paths: - name: is_enabled in: query description: The fulfillment provider's is enabled. - required: true + required: false schema: type: boolean title: is_enabled @@ -8644,7 +7929,7 @@ paths: /admin/fulfillment-sets/{id}: delete: operationId: DeleteFulfillmentSetsId - summary: Delete a Fulfillment Set + summary: Delete Fulfillment Set description: Delete a fulfillment set. x-authenticated: true parameters: @@ -8654,46 +7939,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -8725,6 +7970,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteFulfillmentSetsWorkflow /admin/fulfillment-sets/{id}/service-zones: post: operationId: PostFulfillmentSetsIdServiceZones @@ -8932,6 +8178,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createServiceZonesWorkflow /admin/fulfillment-sets/{id}/service-zones/{zone_id}: get: operationId: GetFulfillmentSetsIdServiceZonesZone_id @@ -9250,10 +8497,12 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateServiceZonesWorkflow delete: operationId: DeleteFulfillmentSetsIdServiceZonesZone_id - summary: Remove Service Zones from Fulfillment Set - description: Remove a list of service zones from a fulfillment set. This doesn't delete the Service Zone, only the association between the Service Zone and the fulfillment set. + summary: Remove a Service Zone from Fulfillment Set + x-sidebar-summary: Remove Service Zone + description: Remove a service zone that belongs to a fulfillment set. x-authenticated: true parameters: - name: id @@ -9264,50 +8513,10 @@ paths: type: string - name: zone_id in: path - description: The fulfillment set's zone id. + description: The service zone's ID. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -9315,9 +8524,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Fulfillment Sets responses: @@ -9336,18 +8543,19 @@ paths: id: type: string title: id - description: The fulfillment set's ID. + description: The service zone's ID. object: type: string title: object - description: The fulfillment set's object. + description: The name of the deleted object. + default: service_zone deleted: type: boolean title: deleted - description: The fulfillment set's deleted. + description: Whether the service zone was deleted. parent: type: object - description: The fulfillment set's parent. + description: The fulfillment set that the service zone belongs to. '400': $ref: '#/components/responses/400_error' '401': @@ -9360,6 +8568,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteServiceZonesWorkflow /admin/fulfillments: post: operationId: PostFulfillments @@ -9577,6 +8786,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelFulfillmentWorkflow /admin/fulfillments/{id}/shipment: post: operationId: PostFulfillmentsIdShipment @@ -9676,6 +8886,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createShipmentWorkflow /admin/inventory-items: get: operationId: GetInventoryItems @@ -9818,7 +9029,7 @@ paths: - name: requires_shipping in: query description: The inventory item's requires shipping. - required: true + required: false schema: type: boolean title: requires_shipping @@ -10498,10 +9709,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateInventoryItemsWorkflow delete: operationId: DeleteInventoryItemsId - summary: Delete a Inventory Item - description: Delete a inventory item. + summary: Delete Inventory Item + description: Delete an inventory item. x-authenticated: true parameters: - name: id @@ -10510,46 +9722,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -10582,11 +9754,12 @@ paths: object: type: string title: object - description: The inventory item's object. + description: The name of the deleted object. + default: inventory_item deleted: type: boolean title: deleted - description: The inventory item's deleted. + description: Whether the inventory item was deleted. parent: type: object description: The inventory item's parent. @@ -10602,6 +9775,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteInventoryItemWorkflow /admin/inventory-items/{id}/location-levels: get: operationId: GetInventoryItemsIdLocationLevels @@ -10855,6 +10029,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createInventoryLevelsWorkflow /admin/inventory-items/{id}/location-levels/batch: post: operationId: PostInventoryItemsIdLocationLevelsBatch @@ -10868,46 +10043,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -10996,6 +10131,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: bulkCreateDeleteLevelsWorkflow /admin/inventory-items/{id}/location-levels/{location_id}: post: operationId: PostInventoryItemsIdLocationLevelsLocation_id @@ -11101,10 +10237,15 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateInventoryLevelsWorkflow delete: operationId: DeleteInventoryItemsIdLocationLevelsLocation_id - summary: Remove Location Levels from Inventory Item - description: Remove a list of location levels from a inventory item. This doesn't delete the Location Level, only the association between the Location Level and the inventory item. + summary: Remove Inventory Level of Inventory Item + x-sidebar-summary: Remove Inventory Level + description: | + Remove the inventory level of an inventory item. + + If the inventory level has reserved quantity greater than `0`, an error is thrown. x-authenticated: true parameters: - name: id @@ -11166,9 +10307,7 @@ paths: x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ - -H 'x-medusa-access-token: {api_token}' + source: 'curl -X DELETE ''{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}'' \ -H ''x-medusa-access-token: {api_token}''' tags: - Inventory Items responses: @@ -11187,18 +10326,19 @@ paths: id: type: string title: id - description: The inventory item's ID. + description: The inventory level's ID. object: type: string title: object - description: The inventory item's object. + description: The name of the deleted object. + default: inventory-level deleted: type: boolean title: deleted - description: The inventory item's deleted. + description: Whether the inventory level was deleted. parent: type: object - description: The inventory item's parent. + description: The inventory item of the level. '400': $ref: '#/components/responses/400_error' '401': @@ -11211,6 +10351,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteInventoryLevelsWorkflow /admin/invites: get: operationId: GetInvites @@ -11300,104 +10441,17 @@ paths: in: query description: The invite's created at. required: false - schema: - type: string - description: The invite's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The invite's updated at. required: false - schema: - type: string - description: The invite's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The invite's deleted at. required: false - schema: - type: string - description: The invite's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -11560,6 +10614,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createInvitesWorkflow /admin/invites/accept: post: operationId: PostInvitesAccept @@ -11679,6 +10734,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: acceptInviteWorkflow /admin/invites/{id}: get: operationId: GetInvitesId @@ -11759,8 +10815,8 @@ paths: $ref: '#/components/responses/500_error' delete: operationId: DeleteInvitesId - summary: Delete a Invite - description: Delete a invite. + summary: Delete Invite + description: Delete an invite. x-authenticated: false parameters: - name: id @@ -11769,46 +10825,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. x-codeSamples: - lang: Shell label: cURL @@ -11835,11 +10851,12 @@ paths: object: type: string title: object - description: The invite's object. + description: The name of the deleted object. + default: invite deleted: type: boolean title: deleted - description: The invite's deleted. + description: Whether the invite was deleted. parent: type: object description: The invite's parent. @@ -11855,6 +10872,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteInvitesWorkflow /admin/invites/{id}/resend: post: operationId: PostInvitesIdResend @@ -11937,6 +10955,7 @@ paths: content: application/json: schema: {} + x-workflow: refreshInviteTokensWorkflow /admin/notifications: get: operationId: GetNotifications @@ -12159,47 +11178,7 @@ paths: summary: Create Order Edit description: Create a order edit. x-authenticated: true - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] security: - api_token: [] - cookie_auth: [] @@ -12241,11 +11220,12 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: beginOrderEditOrderWorkflow /admin/order-edits/{id}: delete: operationId: DeleteOrderEditsId - summary: Delete a Order Edit - description: Delete a order edit. + summary: Cancel Order Edit + description: Cancel an order edit. x-authenticated: true parameters: - name: id @@ -12254,46 +11234,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -12326,11 +11266,12 @@ paths: object: type: string title: object - description: The order edit's object. + description: The name of the deleted object. + default: order-edit deleted: type: boolean title: deleted - description: The order edit's deleted. + description: Whether the order edit was deleted. parent: type: object description: The order edit's parent. @@ -12346,6 +11287,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelBeginOrderEditWorkflow /admin/order-edits/{id}/confirm: post: operationId: PostOrderEditsIdConfirm @@ -12359,46 +11301,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -12448,46 +11350,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -12544,46 +11406,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -12644,46 +11466,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -12723,8 +11505,12 @@ paths: x-workflow: updateOrderEditAddItemWorkflow delete: operationId: DeleteOrderEditsIdItemsAction_id - summary: Remove Items from Order Edit - description: Remove a list of items from a order edit. This doesn't delete the Item, only the association between the Item and the order edit. + summary: Remove Item from Order Edit + x-sidebar-summary: Remove Item + description: | + Remove an added item in the order edit by the ID of the item's `ITEM_ADD` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -12735,50 +11521,10 @@ paths: type: string - name: action_id in: path - description: The order edit's action id. + description: The ID of the new item's `ITEM_ADD` action. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -12824,46 +11570,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -12913,46 +11619,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -13013,46 +11679,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -13092,8 +11718,12 @@ paths: x-workflow: updateOrderEditShippingMethodWorkflow delete: operationId: DeleteOrderEditsIdShippingMethodAction_id - summary: Remove Shipping Methods from Order Edit - description: Remove a list of shipping methods from a order edit. This doesn't delete the Shipping Method, only the association between the Shipping Method and the order edit. + summary: Remove Shipping Method from Order Edit + x-sidebar-summary: Remove Shipping Method + description: | + Remove a shipping method in the order edit by the ID of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -13104,50 +11734,10 @@ paths: type: string - name: action_id in: path - description: The order edit's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -13287,6 +11877,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: getOrdersListWorkflow /admin/orders/{id}: get: operationId: GetOrdersId @@ -13371,6 +11962,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: getOrderDetailWorkflow post: operationId: PostOrdersId summary: Update a Order @@ -13551,6 +12143,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: archiveOrderWorkflow /admin/orders/{id}/cancel: post: operationId: PostOrdersIdCancel @@ -13639,6 +12232,97 @@ paths: content: application/json: schema: {} + x-workflow: cancelOrderWorkflow + /admin/orders/{id}/changes: + get: + 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. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + 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 `-`. + required: false + schema: + 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 `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/orders/{id}/changes' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Orders + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderChangesResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/orders/{id}/complete: post: operationId: PostOrdersIdComplete @@ -13748,6 +12432,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: completeOrderWorkflow /admin/orders/{id}/fulfillments: post: operationId: PostOrdersIdFulfillments @@ -13891,6 +12576,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createOrderFulfillmentWorkflow /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel: post: operationId: PostOrdersIdFulfillmentsFulfillment_idCancel @@ -14000,6 +12686,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelOrderFulfillmentWorkflow /admin/orders/{id}/fulfillments/{fulfillment_id}/shipments: post: operationId: PostOrdersIdFulfillmentsFulfillment_idShipments @@ -14166,6 +12853,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createOrderShipmentWorkflow /admin/orders/{id}/preview: get: operationId: GetOrdersIdPreview @@ -14179,46 +12867,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -14364,46 +13012,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -14436,11 +13044,12 @@ paths: object: type: string title: object - description: The payment collection's object. + description: The name of the deleted object. + default: payment-collection deleted: type: boolean title: deleted - description: The payment collection's deleted. + description: Whether the payment collection was deleted. parent: type: object description: The payment collection's parent. @@ -14456,6 +13065,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteOrderPaymentCollections /admin/payment-collections/{id}/mark-as-paid: post: operationId: PostPaymentCollectionsIdMarkAsPaid @@ -14557,6 +13167,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: markPaymentCollectionAsPaid /admin/payments: get: operationId: GetPayments @@ -14644,104 +13255,17 @@ paths: in: query description: The payment's created at. required: false - schema: - type: string - description: The payment's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The payment's updated at. required: false - schema: - type: string - description: The payment's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The payment's deleted at. required: false - schema: - type: string - description: The payment's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -15146,6 +13670,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: capturePaymentWorkflow /admin/payments/{id}/refund: post: operationId: PostPaymentsIdRefund @@ -15249,6 +13774,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: refundPaymentWorkflow /admin/price-lists: get: operationId: GetPriceLists @@ -15416,6 +13942,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createPriceListsWorkflow /admin/price-lists/{id}: get: operationId: GetPriceListsId @@ -15594,6 +14121,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updatePriceListsWorkflow delete: operationId: DeletePriceListsId summary: Delete a Price List @@ -15606,46 +14134,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -15677,6 +14165,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deletePriceListsWorkflow /admin/price-lists/{id}/prices/batch: post: operationId: PostPriceListsIdPricesBatch @@ -15690,46 +14179,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -15850,6 +14299,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchPriceListPricesWorkflow /admin/price-lists/{id}/products: post: operationId: PostPriceListsIdProducts @@ -15955,6 +14405,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchPriceListPricesWorkflow /admin/price-preferences: get: operationId: GetPricePreferences @@ -16115,6 +14566,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createPricePreferencesWorkflow /admin/price-preferences/{id}: get: operationId: GetPricePreferencesId @@ -16287,6 +14739,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updatePricePreferencesWorkflow delete: operationId: DeletePricePreferencesId summary: Delete a Price Preference @@ -16299,46 +14752,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -16370,6 +14783,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deletePricePreferencesWorkflow /admin/product-categories: get: operationId: GetProductCategories @@ -16484,7 +14898,7 @@ paths: - name: include_ancestors_tree in: query description: The product category's include ancestors tree. - required: true + required: false schema: type: boolean title: include_ancestors_tree @@ -16492,7 +14906,7 @@ paths: - name: include_descendants_tree in: query description: The product category's include descendants tree. - required: true + required: false schema: type: boolean title: include_descendants_tree @@ -16500,7 +14914,7 @@ paths: - name: is_internal in: query description: The product category's is internal. - required: true + required: false schema: type: boolean title: is_internal @@ -16508,7 +14922,7 @@ paths: - name: is_active in: query description: The product category's is active. - required: true + required: false schema: type: boolean title: is_active @@ -16517,104 +14931,17 @@ paths: in: query description: The product category's created at. required: false - schema: - type: string - description: The product category's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The product category's updated at. required: false - schema: - type: string - description: The product category's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The product category's deleted at. required: false - schema: - type: string - description: The product category's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -16846,7 +15173,7 @@ paths: - name: include_ancestors_tree in: query description: The product category's include ancestors tree. - required: true + required: false schema: type: boolean title: include_ancestors_tree @@ -16854,7 +15181,7 @@ paths: - name: include_descendants_tree in: query description: The product category's include descendants tree. - required: true + required: false schema: type: boolean title: include_descendants_tree @@ -17019,10 +15346,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateProductCategoriesWorkflow delete: operationId: DeleteProductCategoriesId summary: Delete a Product Category - description: Delete a product category. + description: Delete a product category. This doesn't deleted products in that category. x-authenticated: true parameters: - name: id @@ -17031,46 +15359,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -17102,6 +15390,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteProductCategoriesWorkflow /admin/product-categories/{id}/products: post: operationId: PostProductCategoriesIdProducts @@ -17207,6 +15496,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchLinkProductsToCategoryWorkflow /admin/product-tags: get: operationId: GetProductTags @@ -17294,104 +15584,17 @@ paths: in: query description: The product tag's created at. required: false - schema: - type: string - description: The product tag's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The product tag's updated at. required: false - schema: - type: string - description: The product tag's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The product tag's deleted at. required: false - schema: - type: string - description: The product tag's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -17732,7 +15935,7 @@ paths: delete: operationId: DeleteProductTagsId summary: Delete a Product Tag - description: Delete a product tag. + description: Delete a product tag. This doesn't delete products using the tag. x-authenticated: true parameters: - name: id @@ -17741,46 +15944,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -17812,6 +15975,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteProductTagsWorkflow /admin/product-types: get: operationId: GetProductTypes @@ -17899,104 +16063,17 @@ paths: in: query description: The product type's created at. required: false - schema: - type: string - description: The product type's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The product type's updated at. required: false - schema: - type: string - description: The product type's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The product type's deleted at. required: false - schema: - type: string - description: The product type's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -18337,7 +16414,7 @@ paths: delete: operationId: DeleteProductTypesId summary: Delete a Product Type - description: Delete a product type. + description: Delete a product type. This doesn't delete products of this type. x-authenticated: true parameters: - name: id @@ -18346,46 +16423,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -18417,6 +16454,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteProductTypesWorkflow /admin/product-variants: get: operationId: GetProductVariants @@ -22928,1867 +20966,175 @@ paths: type: array description: The created at's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. + type: object $or: type: array description: The created at's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. + type: object $eq: oneOf: - type: string title: $eq - description: The created at's $eq. - - type: object - description: The created at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + description: Filter by an exact match. - type: array - description: The created at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The created at's $ne. - - type: object - description: The created at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. + type: string + title: $ne $in: type: array description: The created at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. + type: string + title: $in $nin: type: array description: The created at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The created at's $not. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The created at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The created at's $not. + description: Filter by values not matching the conditions in this parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: array - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap - description: The $overlap's details. + description: Filter arrays that have overlapping values with this parameter. $contains: type: array - description: The $not's $contains. + description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: The $contain's $contains. + description: Filter arrays that contain some of the values of this parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: The created at's $not. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The created at's $gt. - - type: object - description: The created at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The created at's $gte. - - type: object - description: The created at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The created at's $lt. - - type: object - description: The created at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The created at's $lte. - - type: object - description: The created at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. + type: string + title: $lte $like: type: string title: $like @@ -24842,1867 +21188,175 @@ paths: type: array description: The updated at's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. + type: object $or: type: array description: The updated at's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. + type: object $eq: oneOf: - type: string title: $eq - description: The updated at's $eq. - - type: object - description: The updated at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + description: Filter by an exact match. - type: array - description: The updated at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The updated at's $ne. - - type: object - description: The updated at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. + type: string + title: $ne $in: type: array description: The updated at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. + type: string + title: $in $nin: type: array description: The updated at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The updated at's $not. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The updated at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The updated at's $not. + description: Filter by values not matching the conditions in this parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: array - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap - description: The $overlap's details. + description: Filter arrays that have overlapping values with this parameter. $contains: type: array - description: The $not's $contains. + description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: The $contain's $contains. + description: Filter arrays that contain some of the values of this parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: The updated at's $not. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The updated at's $gt. - - type: object - description: The updated at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The updated at's $gte. - - type: object - description: The updated at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The updated at's $lt. - - type: object - description: The updated at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The updated at's $lte. - - type: object - description: The updated at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. + type: string + title: $lte $like: type: string title: $like @@ -26756,1867 +21410,175 @@ paths: type: array description: The deleted at's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. + type: object $or: type: array description: The deleted at's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. + type: object $eq: oneOf: - type: string title: $eq - description: The deleted at's $eq. - - type: object - description: The deleted at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + description: Filter by an exact match. - type: array - description: The deleted at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The deleted at's $ne. - - type: object - description: The deleted at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. + type: string + title: $ne $in: type: array description: The deleted at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. + type: string + title: $in $nin: type: array description: The deleted at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The deleted at's $not. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The deleted at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The deleted at's $not. + description: Filter by values not matching the conditions in this parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: array - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap - description: The $overlap's details. + description: Filter arrays that have overlapping values with this parameter. $contains: type: array - description: The $not's $contains. + description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: The $contain's $contains. + description: Filter arrays that contain some of the values of this parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: The deleted at's $not. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The deleted at's $gt. - - type: object - description: The deleted at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The deleted at's $gte. - - type: object - description: The deleted at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The deleted at's $lt. - - type: object - description: The deleted at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The deleted at's $lte. - - type: object - description: The deleted at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. + type: string + title: $lte $like: type: string title: $like @@ -28666,10 +21628,8 @@ paths: type: array description: The product's $and. items: - type: array - items: - type: object - title: $and + type: object + title: $and - name: $or in: query description: The product's $or. @@ -28678,10 +21638,8 @@ paths: type: array description: The product's $or. items: - type: array - items: - type: object - title: $or + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -29011,47 +21969,7 @@ paths: summary: Create Product description: Create a product. x-authenticated: true - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] security: - api_token: [] - cookie_auth: [] @@ -29102,46 +22020,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -29171,6 +22049,7 @@ paths: content: application/json: schema: {} + x-workflow: importProductsWorkflowId /admin/products/{id}: get: operationId: GetProductsId @@ -29364,46 +22243,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -29435,6 +22274,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteProductsWorkflow /admin/products/{id}/options: get: operationId: GetProductsIdOptions @@ -29546,10 +22386,8 @@ paths: type: array description: The product's $and. items: - type: array - items: - type: object - title: $and + type: object + title: $and - name: $or in: query description: The product's $or. @@ -29558,10 +22396,8 @@ paths: type: array description: The product's $or. items: - type: array - items: - type: object - title: $or + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -29725,6 +22561,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createProductOptionsWorkflow /admin/products/{id}/options/{option_id}: get: operationId: GetProductsIdOptionsOption_id @@ -29917,10 +22754,15 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateProductOptionsWorkflow delete: operationId: DeleteProductsIdOptionsOption_id - summary: Remove Options from Product - description: Remove a list of options from a product. This doesn't delete the Option, only the association between the Option and the product. + summary: Delete an Option from Product + x-sidebar-summary: Delete Option + description: | + Delete an option from a product. + + Values of this option in the product's variants are removed. x-authenticated: true parameters: - name: id @@ -29931,7 +22773,7 @@ paths: type: string - name: option_id in: path - description: The product's option id. + description: The product option's ID. required: true schema: type: string @@ -30006,6 +22848,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteProductOptionsWorkflow /admin/products/{id}/variants: get: operationId: GetProductsIdVariants @@ -30220,6 +23063,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createProductVariantsWorkflow /admin/products/{id}/variants/batch: post: operationId: PostProductsIdVariantsBatch @@ -30323,46 +23167,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -30658,10 +23462,12 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateProductVariantsWorkflow delete: operationId: DeleteProductsIdVariantsVariant_id - summary: Remove Variants from Product - description: Remove a list of variants from a product. This doesn't delete the Variant, only the association between the Variant and the product. + summary: Delete Product Variant + x-sidebar-summary: Delete Variant + description: Delete a variant of a product. x-authenticated: true parameters: - name: id @@ -30672,7 +23478,7 @@ paths: type: string - name: variant_id in: path - description: The product's variant id. + description: The product variant's ID. required: true schema: type: string @@ -30747,6 +23553,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteProductVariantsWorkflow /admin/products/{id}/variants/{variant_id}/inventory-items: post: operationId: PostProductsIdVariantsVariant_idInventoryItems @@ -30847,6 +23654,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createLinksWorkflow /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}: post: operationId: PostProductsIdVariantsVariant_idInventoryItemsInventory_item_id @@ -30952,10 +23760,12 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateLinksWorkflow delete: operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id - summary: Remove Inventory Items from Product - description: Remove a list of inventory items from a product. This doesn't delete the Inventory Item, only the association between the Inventory Item and the product. + summary: Remove Inventory Item Association with Product Variant + x-sidebar-summary: Remove Inventory Item + description: Remove the association between an inventory item and its product variant. x-authenticated: true parameters: - name: id @@ -30966,13 +23776,13 @@ paths: type: string - name: variant_id in: path - description: The product's variant id. + description: The products variant's ID. required: true schema: type: string - name: inventory_item_id in: path - description: The product's inventory item id. + description: The inventory item's ID. required: true schema: type: string @@ -31154,104 +23964,17 @@ paths: in: query description: The promotion's created at. required: false - schema: - type: string - description: The promotion's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The promotion's updated at. required: false - schema: - type: string - description: The promotion's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The promotion's deleted at. required: false - schema: - type: string - description: The promotion's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -31706,6 +24429,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createPromotionsWorkflow /admin/promotions/rule-attribute-options/{rule_type}: get: operationId: GetPromotionsRuleAttributeOptionsRule_type @@ -31719,46 +24443,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - name: promotion_type in: query description: The promotion's promotion type. @@ -32375,6 +25059,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updatePromotionsWorkflow delete: operationId: DeletePromotionsId summary: Delete a Promotion @@ -32387,46 +25072,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -32459,11 +25104,12 @@ paths: object: type: string title: object - description: The promotion's object. + description: The name of the deleted object. + default: promotion deleted: type: boolean title: deleted - description: The promotion's deleted. + description: Whether the promotion was deleted. parent: type: object description: The promotion's parent. @@ -32479,6 +25125,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deletePromotionsWorkflow /admin/promotions/{id}/buy-rules/batch: post: operationId: PostPromotionsIdBuyRulesBatch @@ -33643,6 +26290,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateRefundReasonsWorkflow delete: operationId: DeleteRefundReasonsId summary: Delete a Refund Reason @@ -33655,46 +26303,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -33727,11 +26335,12 @@ paths: object: type: string title: object - description: The refund reason's object. + description: The name of the deleted object. + default: refund_reason deleted: type: boolean title: deleted - description: The refund reason's deleted. + description: Whether the refund reason was deleted. parent: type: object description: The refund reason's parent. @@ -33747,6 +26356,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteReturnReasonsWorkflow /admin/regions: get: operationId: GetRegions @@ -33848,104 +26458,17 @@ paths: in: query description: The region's created at. required: false - schema: - type: string - description: The region's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The region's updated at. required: false - schema: - type: string - description: The region's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The region's deleted at. required: false - schema: - type: string - description: The region's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -34378,46 +26901,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -34450,11 +26933,12 @@ paths: object: type: string title: object - description: The region's object. + description: The name of the deleted object. + default: region deleted: type: boolean title: deleted - description: The region's deleted. + description: Whether the region was deleted. parent: type: object description: The region's parent. @@ -34470,6 +26954,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteRegionsWorkflow /admin/reservations: get: operationId: GetReservations @@ -34645,104 +27130,17 @@ paths: in: query description: The reservation's created at. required: false - schema: - type: string - description: The reservation's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The reservation's updated at. required: false - schema: - type: string - description: The reservation's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The reservation's deleted at. required: false - schema: - type: string - description: The reservation's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} security: - api_token: [] - cookie_auth: [] @@ -35124,6 +27522,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateReservationsWorkflow delete: operationId: DeleteReservationsId summary: Delete a Reservation @@ -35136,46 +27535,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -35208,11 +27567,12 @@ paths: object: type: string title: object - description: The reservation's object. + description: The name of the deleted object. + default: reservation deleted: type: boolean title: deleted - description: The reservation's deleted. + description: Whether the reservation was deleted. parent: type: object description: The reservation's parent. @@ -35228,6 +27588,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteReservationsWorkflow /admin/return-reasons: get: operationId: GetReturnReasons @@ -35357,29 +27718,17 @@ paths: in: query description: The return reason's created at. required: false - schema: - type: string - format: date-time - title: created_at - description: The return reason's created at. + schema: {} - name: updated_at in: query description: The return reason's updated at. required: false - schema: - type: string - format: date-time - title: updated_at - description: The return reason's updated at. + schema: {} - name: deleted_at in: query description: The return reason's deleted at. required: false - schema: - type: string - format: date-time - title: deleted_at - description: The return reason's deleted at. + schema: {} - name: $and in: query description: The return reason's $and. @@ -35518,6 +27867,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createReturnReasonsWorkflow /admin/return-reasons/{id}: get: operationId: GetReturnReasonsId @@ -35690,6 +28040,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateReturnReasonsWorkflow delete: operationId: DeleteReturnReasonsId summary: Delete a Return Reason @@ -35702,46 +28053,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -35774,11 +28085,12 @@ paths: object: type: string title: object - description: The return reason's object. + description: The name of the deleted object. + default: return_reason deleted: type: boolean title: deleted - description: The return reason's deleted. + description: Whether the return reason was deleted. parent: type: object description: The return reason's parent. @@ -35794,6 +28106,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteReturnReasonsWorkflow /admin/returns: get: operationId: GetReturns @@ -36001,6 +28314,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: beginReturnOrderWorkflow /admin/returns/{id}: get: operationId: GetReturnsId @@ -36191,46 +28505,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -36267,6 +28541,7 @@ paths: application/json: schema: $ref: '#/components/schemas/AdminPostCancelReturnReqSchema' + x-workflow: cancelReturnWorkflow /admin/returns/{id}/dismiss-items: post: operationId: PostReturnsIdDismissItems @@ -36455,8 +28730,12 @@ paths: x-workflow: updateReceiveItemReturnRequestWorkflow delete: operationId: DeleteReturnsIdDismissItemsAction_id - summary: Remove Dismiss Items from Return - description: Remove a list of dismiss items from a return. This doesn't delete the Dismiss Item, only the association between the Dismiss Item and the return. + summary: Remove Damaged Item from Return + x-sidebar-summary: Remove Damaged Item + description: | + Remove a damaged item, whose quantity is to be dismissed, in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -36467,7 +28746,7 @@ paths: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action. required: true schema: type: string @@ -36645,10 +28924,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: beginReceiveReturnWorkflow delete: operationId: DeleteReturnsIdReceive - summary: Remove Receives from Return - description: Remove a list of receives from a return. This doesn't delete the Receive, only the association between the Receive and the return. + summary: Cancel Return Receival + description: Cancel the receival process previously started, and hasn't been confirmed, of a return. x-authenticated: true parameters: - name: id @@ -36657,46 +28937,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -36729,11 +28969,12 @@ paths: object: type: string title: object - description: The return's object. + description: The name of the returned object. + default: return deleted: type: boolean title: deleted - description: The return's deleted. + description: Whether the return was deleted. parent: type: object description: The return's parent. @@ -36749,6 +28990,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelReturnReceiveWorkflow /admin/returns/{id}/receive-items: post: operationId: PostReturnsIdReceiveItems @@ -36937,8 +29179,12 @@ paths: x-workflow: updateReceiveItemReturnRequestWorkflow delete: operationId: DeleteReturnsIdReceiveItemsAction_id - summary: Remove Receive Items from Return - description: Remove a list of receive items from a return. This doesn't delete the Receive Item, only the association between the Receive Item and the return. + summary: Remove a Received Item from Return + x-sidebar-summary: Remove Received Item + description: | + Remove an item marked as received in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -36949,7 +29195,7 @@ paths: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the received item's `RECEIVE_RETURN_ITEM` action. required: true schema: type: string @@ -37207,8 +29453,8 @@ paths: x-workflow: confirmReturnRequestWorkflow delete: operationId: DeleteReturnsIdRequest - summary: Remove Requests from Return - description: Remove a list of requests from a return. This doesn't delete the Request, only the association between the Request and the return. + summary: Cancel Return Request + description: Cancel a requested return. x-authenticated: true parameters: - name: id @@ -37217,46 +29463,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -37289,11 +29495,12 @@ paths: object: type: string title: object - description: The return's object. + description: The name of the deleted object. + default: return deleted: type: boolean title: deleted - description: The return's deleted. + description: Whether the return was deleted. parent: type: object description: The return's parent. @@ -37309,6 +29516,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: cancelReturnRequestWorkflow /admin/returns/{id}/request-items: post: operationId: PostReturnsIdRequestItems @@ -37497,8 +29705,12 @@ paths: x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteReturnsIdRequestItemsAction_id - summary: Remove Request Items from Return - description: Remove a list of request items from a return. This doesn't delete the Request Item, only the association between the Request Item and the return. + summary: Remove Item from Return + x-sidebar-summary: Remove Item + description: | + Remove an item in the return by the ID of the item's `RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -37509,7 +29721,7 @@ paths: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the item's `RETURN_ITEM` action. required: true schema: type: string @@ -37959,7 +30171,7 @@ paths: - name: is_disabled in: query description: The sales channel's is disabled. - required: true + required: false schema: type: boolean title: is_disabled @@ -37968,104 +30180,17 @@ paths: in: query description: The sales channel's created at. required: false - schema: - type: string - description: The sales channel's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The sales channel's updated at. required: false - schema: - type: string - description: The sales channel's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The sales channel's deleted at. required: false - schema: - type: string - description: The sales channel's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: location_id in: query required: false @@ -38438,6 +30563,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateSalesChannelsWorkflow delete: operationId: DeleteSalesChannelsId summary: Delete a Sales Channel @@ -38450,46 +30576,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -38521,6 +30607,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteSalesChannelsWorkflow /admin/sales-channels/{id}/products: post: operationId: PostSalesChannelsIdProducts @@ -38626,6 +30713,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: linkProductsToSalesChannelWorkflow /admin/shipping-options: get: operationId: GetShippingOptions @@ -38755,104 +30843,17 @@ paths: in: query description: The shipping option's created at. required: false - schema: - type: string - description: The shipping option's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The shipping option's updated at. required: false - schema: - type: string - description: The shipping option's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The shipping option's deleted at. required: false - schema: - type: string - description: The shipping option's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: stock_location_id in: query required: false @@ -39147,6 +31148,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createShippingOptionsWorkflow /admin/shipping-options/{id}: post: operationId: PostShippingOptionsId @@ -39389,6 +31391,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateShippingOptionsWorkflow delete: operationId: DeleteShippingOptionsId summary: Delete a Shipping Option @@ -39401,46 +31404,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -39472,6 +31435,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteShippingOptionsWorkflow /admin/shipping-options/{id}/rules/batch: post: operationId: PostShippingOptionsIdRulesBatch @@ -39778,104 +31742,17 @@ paths: in: query description: The shipping profile's created at. required: false - schema: - type: string - description: The shipping profile's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The shipping profile's updated at. required: false - schema: - type: string - description: The shipping profile's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The shipping profile's deleted at. required: false - schema: - type: string - description: The shipping profile's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -40251,6 +32128,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateShippingProfilesWorkflow delete: operationId: DeleteShippingProfilesId summary: Delete a Shipping Profile @@ -40263,46 +32141,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -40334,6 +32172,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteShippingProfileWorkflow /admin/stock-locations: get: operationId: GetStockLocations @@ -40449,104 +32288,17 @@ paths: in: query description: The stock location's created at. required: false - schema: - type: string - description: The stock location's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The stock location's updated at. required: false - schema: - type: string - description: The stock location's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The stock location's deleted at. required: false - schema: - type: string - description: The stock location's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -40862,6 +32614,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateStockLocationsWorkflow delete: operationId: DeleteStockLocationsId summary: Delete a Stock Location @@ -40874,46 +32627,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -40945,6 +32658,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteStockLocationsWorkflow /admin/stock-locations/{id}/fulfillment-providers: post: operationId: PostStockLocationsIdFulfillmentProviders @@ -41050,6 +32764,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: batchLinksWorkflow /admin/stock-locations/{id}/fulfillment-sets: post: operationId: PostStockLocationsIdFulfillmentSets @@ -41157,6 +32872,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createLocationFulfillmentSetWorkflow /admin/stock-locations/{id}/sales-channels: post: operationId: PostStockLocationsIdSalesChannels @@ -41262,6 +32978,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: linkSalesChannelsToStockLocationWorkflow /admin/stores: get: operationId: GetStores @@ -41684,104 +33401,17 @@ paths: in: query description: The tax rate's created at. required: false - schema: - type: string - description: The tax rate's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The tax rate's updated at. required: false - schema: - type: string - description: The tax rate's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The tax rate's deleted at. required: false - schema: - type: string - description: The tax rate's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -42125,6 +33755,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateTaxRatesWorkflow delete: operationId: DeleteTaxRatesId summary: Delete a Tax Rate @@ -42137,46 +33768,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -42208,6 +33799,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteTaxRatesWorkflow /admin/tax-rates/{id}/rules: post: operationId: PostTaxRatesIdRules @@ -42302,6 +33894,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createTaxRateRulesWorkflow /admin/tax-rates/{id}/rules/{rule_id}: delete: operationId: DeleteTaxRatesIdRulesRule_id @@ -42413,6 +34006,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteTaxRateRulesWorkflow /admin/tax-regions: get: operationId: GetTaxRegions @@ -42626,104 +34220,17 @@ paths: in: query description: The tax region's created at. required: false - schema: - type: string - description: The tax region's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The tax region's updated at. required: false - schema: - type: string - description: The tax region's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The tax region's deleted at. required: false - schema: - type: string - description: The tax region's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -42988,46 +34495,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -43059,53 +34526,14 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteTaxRegionsWorkflow /admin/uploads: post: operationId: PostUploads summary: Create Upload description: Create a upload. x-authenticated: true - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] security: - api_token: [] - cookie_auth: [] @@ -43239,46 +34667,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -43331,6 +34719,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteFilesWorkflow /admin/users: get: operationId: GetUsers @@ -43642,6 +35031,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateUsersWorkflow delete: operationId: DeleteUsersId summary: Delete a User @@ -43654,46 +35044,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. x-codeSamples: - lang: Shell label: cURL @@ -43719,6 +35069,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteUsersWorkflow /admin/workflows-executions: get: operationId: GetWorkflowsExecutions @@ -43951,46 +35302,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -44045,46 +35356,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -44147,46 +35418,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -44249,46 +35480,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -44429,46 +35620,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -44686,6 +35837,67 @@ paths: $ref: '#/components/responses/500_error' components: schemas: + AdminApiKey: + type: object + description: The api key's details. + x-schemaName: AdminApiKey + required: + - id + - token + - redacted + - title + - type + - last_used_at + - created_by + - created_at + - revoked_by + - revoked_at + properties: + id: + type: string + title: id + description: The api key's ID. + token: + type: string + title: token + description: The api key's token. + redacted: + type: string + title: redacted + description: The api key's redacted. + title: + type: string + title: title + description: The api key's title. + type: + type: string + description: The api key's type. + enum: + - secret + - publishable + last_used_at: + type: string + title: last_used_at + description: The api key's last used at. + format: date-time + created_by: + type: string + title: created_by + description: The api key's created by. + created_at: + type: string + format: date-time + title: created_at + description: The api key's created at. + revoked_by: + type: string + title: revoked_by + description: The api key's revoked by. + revoked_at: + type: string + title: revoked_at + description: The api key's revoked at. + format: date-time AdminApiKeyResponse: type: object description: SUMMARY @@ -44694,7 +35906,7 @@ components: - api_key properties: api_key: - $ref: '#/components/schemas/ApiKeyResponse' + $ref: '#/components/schemas/AdminApiKey' AdminArchiveOrder: type: object description: SUMMARY @@ -44749,7 +35961,7 @@ components: $ref: '#/components/schemas/AdminProduct' deleted: type: object - description: The product's deleted. + description: SUMMARY required: - ids - object @@ -44765,11 +35977,11 @@ components: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY AdminBatchProductVariantRequest: type: object description: SUMMARY @@ -44813,7 +36025,7 @@ components: $ref: '#/components/schemas/AdminProductVariant' deleted: type: object - description: The product's deleted. + description: SUMMARY required: - ids - object @@ -44829,11 +36041,85 @@ components: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY + AdminCampaign: + type: object + description: The campaign's details. + x-schemaName: AdminCampaign + required: + - id + - name + - description + - currency + - campaign_identifier + - starts_at + - ends_at + - budget + properties: + id: + type: string + title: id + description: The campaign's ID. + name: + type: string + title: name + description: The campaign's name. + description: + type: string + title: description + description: The campaign's description. + currency: + type: string + title: currency + description: The campaign's currency. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + budget: + type: object + description: The campaign's budget. + required: + - id + - type + - currency_code + - limit + - used + properties: + id: + type: string + title: id + description: The budget's ID. + type: + type: string + description: The budget's type. + enum: + - spend + - usage + currency_code: + type: string + title: currency_code + description: The budget's currency code. + limit: + type: number + title: limit + description: The budget's limit. + used: + type: number + title: used + description: The budget's used. AdminCampaignResponse: type: object description: SUMMARY @@ -44842,7 +36128,7 @@ components: - campaign properties: campaign: - $ref: '#/components/schemas/CampaignResponse' + $ref: '#/components/schemas/AdminCampaign' AdminCancelFulfillment: type: object description: SUMMARY @@ -44963,6 +36249,7 @@ components: $ref: '#/components/schemas/BasePaymentCollection' payment_status: type: string + description: The claim's payment status. enum: - canceled - not_paid @@ -44981,6 +36268,7 @@ components: $ref: '#/components/schemas/BaseOrderFulfillment' fulfillment_status: type: string + description: The claim's fulfillment status. enum: - canceled - not_fulfilled @@ -45114,12 +36402,12 @@ components: object: type: string title: object - description: The claim's object. + description: The name of the deleted object. default: claim deleted: type: boolean title: deleted - description: The claim's deleted. + description: Whether the Claim was deleted. parent: type: object description: The claim's parent. @@ -45274,12 +36562,12 @@ components: object: type: string title: object - description: The collection's object. + description: The name of the deleted object. default: collection deleted: type: boolean title: deleted - description: The collection's deleted. + description: Whether the Collection was deleted. parent: type: object description: The collection's parent. @@ -45333,6 +36621,7 @@ components: description: The api key's title. type: type: string + description: The api key's type. enum: - publishable - secret @@ -45583,11 +36872,13 @@ components: description: The price list's ends at. status: type: string + description: The price list's status. enum: - active - draft type: type: string + description: The price list's type. enum: - sale - override @@ -45697,6 +36988,7 @@ components: description: The create's handle. status: type: string + description: The create's status. enum: - draft - proposed @@ -46199,6 +37491,7 @@ components: compensate_input: {} action: type: string + description: The workflows execution's action. enum: - invoke - compensate @@ -46624,6 +37917,7 @@ components: $ref: '#/components/schemas/BasePaymentCollection' payment_status: type: string + description: The exchange's payment status. enum: - canceled - not_paid @@ -46642,6 +37936,7 @@ components: $ref: '#/components/schemas/BaseOrderFulfillment' fulfillment_status: type: string + description: The exchange's fulfillment status. enum: - canceled - not_fulfilled @@ -47266,12 +38561,12 @@ components: object: type: string title: object - description: The fulfillment set's object. + description: The name of the deleted object. default: fulfillment_set deleted: type: boolean title: deleted - description: The fulfillment set's deleted. + description: Whether the Fulfillment Set was deleted. parent: type: object description: The fulfillment set's parent. @@ -47446,14 +38741,14 @@ components: description: The invite's metadata. created_at: type: string + format: date-time title: created_at description: The invite's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The invite's updated at. - format: date-time AdminInviteResponse: type: object description: SUMMARY @@ -47666,6 +38961,7 @@ components: $ref: '#/components/schemas/BaseOrderShippingMethod' payment_status: type: string + description: The order's payment status. enum: - canceled - not_paid @@ -47679,6 +38975,7 @@ components: - requires_action fulfillment_status: type: string + description: The order's fulfillment status. enum: - canceled - not_fulfilled @@ -47796,6 +39093,18 @@ components: type: number title: original_shipping_tax_total description: The order's original shipping tax total. + AdminOrderChangesResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderChangesResponse + required: + - order_changes + properties: + order_changes: + type: array + description: The order's order changes. + items: + $ref: '#/components/schemas/BaseOrderChange' AdminOrderEditPreviewResponse: type: object description: SUMMARY @@ -48017,14 +39326,14 @@ components: $ref: '#/components/schemas/BaseOrderItemDetail' created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -48322,6 +39631,7 @@ components: $ref: '#/components/schemas/AdminPaymentCollection' payment_status: type: string + description: The order preview's payment status. enum: - canceled - not_paid @@ -48340,6 +39650,7 @@ components: $ref: '#/components/schemas/BaseOrderFulfillment' fulfillment_status: type: string + description: The order preview's fulfillment status. enum: - canceled - not_fulfilled @@ -48714,6 +40025,7 @@ components: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid @@ -48809,6 +40121,7 @@ components: description: The item's quantity. reason: type: string + description: The item's reason. enum: - missing_item - wrong_item @@ -49080,6 +40393,7 @@ components: properties: type: type: string + description: The claim's type. enum: - refund - replace @@ -49595,11 +40909,13 @@ components: description: The price list's ends at. status: type: string + description: The price list's status. enum: - draft - active type: type: string + description: The price list's type. enum: - sale - override @@ -49644,7 +40960,7 @@ components: $ref: '#/components/schemas/AdminPrice' deleted: type: object - description: The price list's deleted. + description: SUMMARY required: - ids - object @@ -49660,11 +40976,11 @@ components: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY AdminPriceListDeleteResponse: type: object description: SUMMARY @@ -49681,12 +40997,12 @@ components: object: type: string title: object - description: The price list's object. + description: The name of the deleted object. default: price_list deleted: type: boolean title: deleted - description: The price list's deleted. + description: Whether the Price List was deleted. parent: type: object description: The price list's parent. @@ -49858,12 +41174,12 @@ components: object: type: string title: object - description: The price preference's object. + description: The name of the deleted object. default: price_preference deleted: type: boolean title: deleted - description: The price preference's deleted. + description: Whether the Price Preference was deleted. parent: type: object description: The price preference's parent. @@ -49953,7 +41269,7 @@ components: items: $ref: '#/components/schemas/AdminProductVariant' type: - type: object + $ref: '#/components/schemas/AdminProductType' tags: type: array description: The parent's tags. @@ -49965,6 +41281,7 @@ components: description: The parent's title. status: type: string + description: The parent's status. enum: - draft - proposed @@ -50113,6 +41430,9 @@ components: type: string title: id description: The category's ID. + metadata: + type: object + description: The category's metadata. created_at: type: string format: date-time @@ -50164,12 +41484,12 @@ components: object: type: string title: object - description: The product category's object. + description: The name of the deleted object. default: product_category deleted: type: boolean title: deleted - description: The product category's deleted. + description: Whether the Product Category was deleted. parent: type: object description: The product category's parent. @@ -50225,12 +41545,12 @@ components: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: product deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: type: object description: The product's parent. @@ -50295,12 +41615,12 @@ components: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: product_option deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: '#/components/schemas/AdminProduct' AdminProductOptionResponse: @@ -50373,12 +41693,12 @@ components: object: type: string title: object - description: The product tag's object. + description: The name of the deleted object. default: product_tag deleted: type: boolean title: deleted - description: The product tag's deleted. + description: Whether the Product Tag was deleted. parent: type: object description: The product tag's parent. @@ -50418,6 +41738,42 @@ components: properties: product_tag: $ref: '#/components/schemas/AdminProductTag' + AdminProductType: + type: object + description: The parent's type. + x-schemaName: AdminProductType + required: + - id + - value + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The type's ID. + value: + type: string + title: value + description: The type's value. + created_at: + type: string + format: date-time + title: created_at + description: The type's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The type's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The type's deleted at. + metadata: + type: object + description: The type's metadata. AdminProductTypeDeleteResponse: type: object description: SUMMARY @@ -50434,12 +41790,12 @@ components: object: type: string title: object - description: The product type's object. + description: The name of the deleted object. default: product_type deleted: type: boolean title: deleted - description: The product type's deleted. + description: Whether the Product Type was deleted. parent: type: object description: The product type's parent. @@ -50469,7 +41825,7 @@ components: type: array description: The product type's product types. items: - $ref: '#/components/schemas/AdminProduct' + $ref: '#/components/schemas/AdminProductType' AdminProductTypeResponse: type: object description: SUMMARY @@ -50478,7 +41834,7 @@ components: - product_type properties: product_type: - $ref: '#/components/schemas/AdminProduct' + $ref: '#/components/schemas/AdminProductType' AdminProductVariant: type: object description: The product's parent. @@ -50626,12 +41982,12 @@ components: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: variant deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: '#/components/schemas/AdminProduct' AdminProductVariantInventoryBatchResponse: @@ -50713,10 +42069,10 @@ components: oneOf: - $ref: '#/components/schemas/AdminProductVariantInventoryLink' - type: array - description: The product's deleted. + description: SUMMARY items: type: object - description: The deleted's details. + description: SUMMARY x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -50785,11 +42141,11 @@ components: object: type: string title: object - description: The product's object. + description: The name of the deleted object. deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: '#/components/schemas/AdminProductVariant' AdminProductVariantParams: @@ -50857,20 +42213,14 @@ components: type: array description: The variant's $and. items: - type: array - description: The $and's details. - items: - type: object - title: $and + type: object + title: $and $or: type: array description: The variant's $or. items: - type: array - description: The $or's details. - items: - type: object - title: $or + type: object + title: $or AdminProductVariantResponse: type: object description: SUMMARY @@ -50897,6 +42247,7 @@ components: description: The promotion's code. type: type: string + description: The promotion's type. enum: - standard - buyget @@ -50916,7 +42267,7 @@ components: title: campaign_id description: The promotion's campaign id. campaign: - $ref: '#/components/schemas/CampaignResponse' + $ref: '#/components/schemas/AdminCampaign' AdminPromotionResponse: type: object description: SUMMARY @@ -50948,6 +42299,7 @@ components: description: The updated's attribute. operator: type: string + description: The updated's operator. enum: - gt - lt @@ -51054,6 +42406,73 @@ components: properties: region: $ref: '#/components/schemas/AdminRegion' + AdminReservation: + type: object + description: The reservation's details. + x-schemaName: AdminReservation + required: + - id + - line_item_id + - location_id + - quantity + - external_id + - description + - inventory_item_id + - inventory_item + properties: + id: + type: string + title: id + description: The reservation's ID. + line_item_id: + type: string + title: line_item_id + description: The reservation's line item id. + location_id: + type: string + title: location_id + description: The reservation's location id. + quantity: + type: string + title: quantity + description: The reservation's quantity. + external_id: + type: string + title: external_id + description: The reservation's external id. + description: + type: string + title: description + description: The reservation's description. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + inventory_item: + type: object + description: The reservation's inventory item. + metadata: + type: object + description: The reservation's metadata. + created_by: + type: string + title: created_by + description: The reservation's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The reservation's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The reservation's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The reservation's updated at. AdminReservationResponse: type: object description: SUMMARY @@ -51062,7 +42481,7 @@ components: - reservation properties: reservation: - $ref: '#/components/schemas/ReservationResponse' + $ref: '#/components/schemas/AdminReservation' AdminReturn: type: object description: The exchange's return. @@ -51075,6 +42494,7 @@ components: - items - received_at - created_at + - canceled_at properties: id: type: string @@ -51130,6 +42550,10 @@ components: format: date-time title: created_at description: The return's created at. + canceled_at: + type: string + title: canceled_at + description: The return's canceled at. AdminReturnItem: type: object description: The return item's return items. @@ -51138,6 +42562,7 @@ components: - id - quantity - received_quantity + - damaged_quantity - item_id - return_id properties: @@ -51153,6 +42578,10 @@ components: type: number title: received_quantity description: The return item's received quantity. + damaged_quantity: + type: number + title: damaged_quantity + description: The return item's damaged quantity. reason_id: type: string title: reason_id @@ -51405,12 +42834,12 @@ components: object: type: string title: object - description: The sales channel's object. + description: The name of the deleted object. default: sales-channel deleted: type: boolean title: deleted - description: The sales channel's deleted. + description: Whether the Sales Channel was deleted. parent: type: object description: The sales channel's parent. @@ -51506,12 +42935,12 @@ components: object: type: string title: object - description: The shipping option's object. + description: The name of the deleted object. default: shipping_option deleted: type: boolean title: deleted - description: The shipping option's deleted. + description: Whether the Shipping Option was deleted. parent: type: object description: The shipping option's parent. @@ -51600,12 +43029,12 @@ components: object: type: string title: object - description: The shipping profile's object. + description: The name of the deleted object. default: shipping_profile deleted: type: boolean title: deleted - description: The shipping profile's deleted. + description: Whether the Shipping Profile was deleted. parent: type: object description: The shipping profile's parent. @@ -51676,12 +43105,12 @@ components: object: type: string title: object - description: The stock location's object. + description: The name of the deleted object. default: stock_location deleted: type: boolean title: deleted - description: The stock location's deleted. + description: Whether the Stock Location was deleted. parent: type: object description: The stock location's parent. @@ -51950,12 +43379,12 @@ components: object: type: string title: object - description: The tax rate's object. + description: The name of the deleted object. default: tax_rate deleted: type: boolean title: deleted - description: The tax rate's deleted. + description: Whether the Tax Rate was deleted. parent: type: object description: The tax rate's parent. @@ -52098,12 +43527,12 @@ components: object: type: string title: object - description: The tax region's object. + description: The name of the deleted object. default: tax_region deleted: type: boolean title: deleted - description: The tax region's deleted. + description: Whether the Tax Region was deleted. parent: type: object description: The tax region's parent. @@ -52186,11 +43615,13 @@ components: description: The price list's ends at. status: type: string + description: The price list's status. enum: - active - draft type: type: string + description: The price list's type. enum: - sale - override @@ -52262,6 +43693,7 @@ components: description: The update's handle. status: type: string + description: The update's status. enum: - draft - proposed @@ -52904,12 +44336,12 @@ components: object: type: string title: object - description: The user's object. + description: The name of the deleted object. default: user deleted: type: boolean title: deleted - description: The user's deleted. + description: Whether the User was deleted. parent: type: object description: The user's parent. @@ -52962,7 +44394,6 @@ components: - state - created_at - updated_at - - deleted_at properties: id: type: string @@ -52977,29 +44408,45 @@ components: title: transaction_id description: The workflow execution's transaction id. execution: - type: string - title: execution - description: The workflow execution's execution. + $ref: '#/components/schemas/AdminWorkflowExecutionExecution' context: + $ref: '#/components/schemas/WorkflowExecutionContext' + state: type: string - title: context - description: The workflow execution's context. - state: {} + description: The workflow execution's state. + enum: + - not_started + - invoking + - waiting_to_compensate + - compensating + - done + - reverted + - failed created_at: type: string + format: date-time title: created_at description: The workflow execution's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The workflow execution's updated at. - format: date-time deleted_at: type: string + format: date-time title: deleted_at description: The workflow execution's deleted at. - format: date-time + AdminWorkflowExecutionExecution: + type: object + description: The workflow execution's execution. + x-schemaName: AdminWorkflowExecutionExecution + required: + - steps + properties: + steps: + type: object + description: The execution's steps. AdminWorkflowExecutionResponse: type: object description: SUMMARY @@ -53115,17 +44562,20 @@ components: description: The application method's ID. type: type: string + description: The application method's type. enum: - fixed - percentage target_type: type: string + description: The application method's target type. enum: - items - shipping_methods - order allocation: type: string + description: The application method's allocation. enum: - each - across @@ -53457,19 +44907,19 @@ components: description: The item's metadata. created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time deleted_at: type: string + format: date-time title: deleted_at description: The item's deleted at. - format: date-time original_total: oneOf: - type: string @@ -53820,6 +45270,7 @@ components: description: The claim item's quantity. reason: type: string + description: The claim item's reason. enum: - missing_item - wrong_item @@ -54213,6 +45664,7 @@ components: description: The order change's version. change_type: type: string + description: The order change's change type. enum: - return - exchange @@ -54303,14 +45755,14 @@ components: description: The fulfillment's metadata. created_at: type: string + format: date-time title: created_at description: The fulfillment's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The fulfillment's updated at. - format: date-time BaseOrderItemDetail: type: object description: The item's detail. @@ -54464,14 +45916,14 @@ components: $ref: '#/components/schemas/BaseOrderItemDetail' created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -54950,6 +46402,7 @@ components: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid @@ -55037,6 +46490,7 @@ components: description: The product's is giftcard. status: type: string + description: The product's status. enum: - draft - proposed @@ -55227,6 +46681,7 @@ components: description: The rule's attribute. operator: type: string + description: The rule's operator. enum: - gt - lt @@ -55945,6 +47400,7 @@ components: description: The order change's version. change_type: type: string + description: The order change's change type. enum: - return - exchange @@ -56291,14 +47747,14 @@ components: $ref: '#/components/schemas/OrderItem' created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -56738,6 +48194,7 @@ components: x-schemaName: OrderChangeAction status: type: string + description: The order preview's status. enum: - canceled - requires_action @@ -58141,6 +49598,391 @@ components: title: original_shipping_tax_total description: The cart's original shipping tax total. - $ref: '#/components/schemas/IBigNumber' + StoreCartAddress: + type: object + description: The cart's billing address. + x-schemaName: StoreCartAddress + required: + - id + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + oneOf: + - type: string + title: created_at + description: The billing address's created at. + - type: string + title: created_at + description: The billing address's created at. + format: date-time + updated_at: + oneOf: + - type: string + title: updated_at + description: The billing address's updated at. + - type: string + title: updated_at + description: The billing address's updated at. + format: date-time + StoreCartLineItem: + type: object + description: The item's items. + x-schemaName: StoreCartLineItem + required: + - id + - title + - quantity + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - cart + - cart_id + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + quantity: + oneOf: + - type: string + title: quantity + description: The item's quantity. + - type: number + title: quantity + description: The item's quantity. + - type: string + title: quantity + description: The item's quantity. + - $ref: '#/components/schemas/IBigNumber' + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant: + $ref: '#/components/schemas/BaseProductVariant' + variant_id: + type: string + title: variant_id + description: The item's variant id. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + oneOf: + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - type: number + title: compare_at_unit_price + description: The item's compare at unit price. + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - $ref: '#/components/schemas/IBigNumber' + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: string + title: unit_price + description: The item's unit price. + - $ref: '#/components/schemas/IBigNumber' + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/BaseLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/BaseLineItemAdjustment' + cart: + $ref: '#/components/schemas/BaseCart' + cart_id: + type: string + title: cart_id + description: The item's cart id. + metadata: + type: object + description: The item's metadata. + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The item's deleted at. + format: date-time + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: '#/components/schemas/IBigNumber' StoreCartResponse: type: object description: SUMMARY @@ -58658,6 +50500,7 @@ components: $ref: '#/components/schemas/BasePaymentCollection' payment_status: type: string + description: The order's payment status. enum: - canceled - not_paid @@ -58676,6 +50519,7 @@ components: $ref: '#/components/schemas/BaseOrderFulfillment' fulfillment_status: type: string + description: The order's fulfillment status. enum: - canceled - not_fulfilled @@ -58898,6 +50742,7 @@ components: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid @@ -59053,6 +50898,7 @@ components: description: The product's title. status: type: string + description: The product's status. enum: - draft - proposed @@ -59233,6 +51079,9 @@ components: description: The category's category children. items: $ref: '#/components/schemas/BaseProductCategory' + metadata: + type: object + description: The category's metadata. created_at: type: string format: date-time @@ -59353,6 +51202,7 @@ components: - items - received_at - created_at + - canceled_at properties: id: type: string @@ -59408,6 +51258,10 @@ components: format: date-time title: created_at description: The return's created at. + canceled_at: + type: string + title: canceled_at + description: The return's canceled at. StoreReturnReason: type: object description: The return reason's details. @@ -59495,6 +51349,7 @@ components: description: The shipping option's name. price_type: type: string + description: The shipping option's price type. enum: - flat - calculated @@ -59712,6 +51567,26 @@ components: metadata: type: object description: The return reason's metadata. + WorkflowExecutionContext: + type: object + description: The workflow execution's context. + x-schemaName: WorkflowExecutionContext + required: + - compensate + - errors + properties: + data: + type: object + description: The context's data. + compensate: + type: object + description: The context's compensate. + errors: + type: array + description: The context's errors. + items: + type: object + description: The error's errors. responses: default_error: description: Default Error diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index f917741490..9cb4d4c520 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -9,12 +9,6 @@ servers: - url: http://localhost:9000 - url: https://api.medusajs.com tags: - - name: Auth - description: | - Auth API routes allow you to manage an admin user's authentication. - externalDocs: - description: Learn more about the Auth Module - url: https://docs.medusajs.com/v2/resources/commerce-modules/auth - name: Api Keys description: > API keys can be used for authentication or resource-scoping. @@ -30,6 +24,8 @@ tags: externalDocs: description: Learn more about the API Key Module url: https://docs.medusajs.com/v2/resources/commerce-modules/api-key + x-associatedSchema: + $ref: ./components/schemas/AdminApiKey.yaml - name: Campaigns description: > A campaign is a group of promotions that have the same conditions, such as @@ -42,6 +38,8 @@ tags: description: Learn more about campaigns. url: >- https://docs.medusajs.com/v2/resources/commerce-modules/promotion/campaign + x-associatedSchema: + $ref: ./components/schemas/AdminCampaign.yaml - name: Claims description: > An admin creates a claim for an order when a customer reports that an item @@ -118,8 +116,6 @@ tags: externalDocs: description: Learn more about the Order Module url: https://docs.medusajs.com/v2/resources/commerce-modules/order - x-associatedSchema: - $ref: ./components/schemas/AdminOrder.yaml - name: Exchanges description: > An exchange is the replacement of an item that the customer ordered with @@ -225,8 +221,6 @@ tags: externalDocs: description: Learn more about the Order Module url: https://docs.medusajs.com/v2/resources/commerce-modules/order - x-associatedSchema: - $ref: ./components/schemas/OrderChange.yaml - name: Orders description: | An order is a purchase made by a customer through a storefront. @@ -347,6 +341,8 @@ tags: externalDocs: description: Learn more about the Product Module url: https://docs.medusajs.com/v2/resources/commerce-modules/product + x-associatedSchema: + $ref: ./components/schemas/AdminProductType.yaml - name: Product Variants description: > A product variant is a saleable form of the product. @@ -444,6 +440,8 @@ tags: description: Learn more about reservations and other inventory concepts. url: >- https://docs.medusajs.com/v2/resources/commerce-modules/inventory/concepts + x-associatedSchema: + $ref: ./components/schemas/AdminReservation.yaml - name: Return Reasons description: > A return reason is a possible reason that an item is returned from the @@ -597,8 +595,6 @@ tags: externalDocs: description: Check out available file module providers. url: https://docs.medusajs.com/v2/resources/architectural-modules/file - x-associatedSchema: - $ref: ./components/schemas/AdminFile.yaml - name: Users description: > A user is an admin user that can authenticate and perform functionalities @@ -627,8 +623,6 @@ tags: description: Check out available Workflow Engine Modules url: >- https://docs.medusajs.com/v2/resources/architectural-modules/workflow-engine - x-associatedSchema: - $ref: ./components/schemas/AdminWorkflowExecution.yaml paths: /admin/api-keys: $ref: paths/admin_api-keys.yaml @@ -786,6 +780,8 @@ paths: $ref: paths/admin_orders_{id}_archive.yaml /admin/orders/{id}/cancel: $ref: paths/admin_orders_{id}_cancel.yaml + /admin/orders/{id}/changes: + $ref: paths/admin_orders_{id}_changes.yaml /admin/orders/{id}/complete: $ref: paths/admin_orders_{id}_complete.yaml /admin/orders/{id}/fulfillments: diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml index c10d333661..840a40413d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml @@ -125,62 +125,7 @@ post: summary: Create Api Key description: Create a api key. x-authenticated: true - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml index 389ee8d611..895e09aeaa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml @@ -199,73 +199,20 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateApiKeysWorkflow delete: operationId: DeleteApiKeysId - summary: Delete a Api Key - description: Delete a api key. + summary: Delete an Api Key + description: | + Delete a publishable or secret API key. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -293,18 +240,19 @@ delete: id: type: string title: id - description: The api key's ID. + description: The API key's ID. object: type: string title: object - description: The api key's object. + description: The name of the object that was deleted. + default: api_key deleted: type: boolean title: deleted - description: The api key's deleted. + description: Whether the API key was deleted. parent: type: object - description: The api key's parent. + description: The API key's parent. '400': $ref: ../components/responses/400_error.yaml '401': @@ -317,3 +265,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteApiKeysWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml index 7444130443..81593d3e1b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml @@ -100,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: revokeApiKeysWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml index c529adb478..6fdd40f8dc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml @@ -116,3 +116,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: linkSalesChannelsToApiKeyWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml index cb6e649509..59dd03a7b0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -292,3 +292,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createCampaignsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml index e06b6995dd..6146db68a8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml @@ -261,10 +261,13 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCampaignsWorkflow delete: operationId: DeleteCampaignsId summary: Delete a Campaign - description: Delete a campaign. + description: > + Delete a campaign by its ID. This doesn't delete promotions that belong to + this campaign. x-authenticated: true parameters: - name: id @@ -273,61 +276,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -359,11 +307,12 @@ delete: object: type: string title: object - description: The campaign's object. + description: The name of the object that was deleted. + default: campaign deleted: type: boolean title: deleted - description: The campaign's deleted. + description: Whether the campaign was deleted. parent: type: object description: The campaign's parent. @@ -379,3 +328,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteCampaignsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml index bbe24ec99a..8d2c341d95 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml @@ -116,3 +116,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: addOrRemoveCampaignPromotionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml index aea414052e..bb90f6b589 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -187,3 +187,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: beginClaimOrderWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml index 971eb7f8b3..2aa93db129 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -100,3 +45,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelOrderClaimWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml index 18e6f27ee7..9b0f7bfc71 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_claim-items_{action_id}.yaml @@ -110,10 +110,16 @@ post: x-workflow: updateClaimItemWorkflow delete: operationId: DeleteClaimsIdClaimItemsAction_id - summary: Remove Claim Items from Claim - description: >- - Remove a list of claim items from a claim. This doesn't delete the Claim - Item, only the association between the Claim Item and the claim. + summary: Remove a Claim Item from a Claim + x-sidebar-summary: Remove Claim Item + description: > + Remove an order item from a claim by the ID of the item's `WRITE_OFF_ITEM` + action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -124,7 +130,7 @@ delete: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the order item's `WRITE_OFF_ITEM` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml index 1c0ac78ba4..b7ab76c82e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml index ea30484e3b..f33e59776b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml @@ -16,61 +16,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -111,10 +56,16 @@ post: x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteClaimsIdInboundItemsAction_id - summary: Remove Items from Claim - description: >- - Remove a list of items from a claim. This doesn't delete the Item, only the - association between the Item and the claim. + summary: Remove an Inbound Item from Claim + x-sidebar-summary: Remove Inbound Item + description: > + Remove an inbound (or return) item from a claim using the `ID` of the item's + `RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -125,7 +76,7 @@ delete: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the return item's `RETURN_ITEM` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml index 70e969ea02..d6bb7c9906 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml index 956afd80c9..f2fdc34e20 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method_{action_id}.yaml @@ -110,11 +110,16 @@ post: x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteClaimsIdInboundShippingMethodAction_id - summary: Remove Shipping Methods from Claim - description: >- - Remove a list of shipping methods from a claim. This doesn't delete the - Shipping Method, only the association between the Shipping Method and the - claim. + summary: Remove Inbound Shipping Method from Claim + x-sidebar-summary: Remove Inbound Shipping Method + description: > + Remove the shipping method for returning items in the claim using the `ID` + of the method's `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -125,65 +130,10 @@ delete: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml index 236075f04f..0fcb8bab71 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_items_{action_id}.yaml @@ -110,10 +110,16 @@ post: x-workflow: updateClaimAddItemWorkflow delete: operationId: DeleteClaimsIdOutboundItemsAction_id - summary: Remove Items from Claim - description: >- - Remove a list of items from a claim. This doesn't delete the Item, only the - association between the Item and the claim. + summary: Remove an Outbound Item from Claim + x-sidebar-summary: Remove Outbound Item + description: > + Remove an outbound (or new) item from a claim using the `ID` of the item's + `ITEM_ADD` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -124,7 +130,7 @@ delete: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the new claim item's `ITEM_ADD` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml index 5691ecd4de..3739658ba1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_outbound_shipping-method_{action_id}.yaml @@ -110,11 +110,16 @@ post: x-workflow: updateClaimShippingMethodWorkflow delete: operationId: DeleteClaimsIdOutboundShippingMethodAction_id - summary: Remove Shipping Methods from Claim - description: >- - Remove a list of shipping methods from a claim. This doesn't delete the - Shipping Method, only the association between the Shipping Method and the - claim. + summary: Remove Outbound Shipping Method from Claim + x-sidebar-summary: Remove Outbound Shipping Method + description: > + Remove the shipping method for delivering outbound items in the claim using + the `ID` of the method's `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -125,7 +130,7 @@ delete: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml index d238d3bdec..75507042e3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml @@ -102,10 +102,8 @@ post: x-workflow: confirmClaimRequestWorkflow delete: operationId: DeleteClaimsIdRequest - summary: Remove Requests from Claim - description: >- - Remove a list of requests from a claim. This doesn't delete the Request, - only the association between the Request and the claim. + summary: Cancel Claim Request + description: Cancel a requested claim. x-authenticated: true parameters: - name: id @@ -114,61 +112,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -199,3 +142,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelBeginOrderClaimWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml index b6cf504f1e..90222acdff 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml @@ -199,10 +199,11 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCollectionsWorkflow delete: operationId: DeleteCollectionsId summary: Delete a Collection - description: Delete a collection. + description: Delete a product collection. x-authenticated: true parameters: - name: id @@ -211,61 +212,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -296,3 +242,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteCollectionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml index bab6fe2366..2e7f0967a5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml @@ -116,3 +116,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchLinkProductsToCollectionWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml index 3b85f06c0a..d4db25ec9e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml @@ -216,3 +216,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createCustomerGroupsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml index 0a08d4a45d..d238d4b844 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml @@ -199,10 +199,12 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCustomerGroupsWorkflow delete: operationId: DeleteCustomerGroupsId summary: Delete a Customer Group - description: Delete a customer group. + description: | + Delete a customer group. Customers in the group aren't deleted. x-authenticated: true parameters: - name: id @@ -211,61 +213,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -317,3 +264,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteCustomerGroupsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml index bd29a1bc67..9fbfcf4601 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml @@ -116,3 +116,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: linkCustomersToCustomerGroupWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index 5bfe96b537..61e0d0413c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -257,3 +257,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createCustomersWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml index 2c3be88568..4fc041cabe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml @@ -243,6 +243,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCustomersWorkflow delete: operationId: DeleteCustomersId summary: Delete a Customer @@ -255,61 +256,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -361,3 +307,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteCustomersWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml index 28bdb52358..f5b482c8e6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml @@ -309,3 +309,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createCustomerAddressesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml index 9e98385ce1..28b44957e2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml @@ -294,12 +294,11 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCustomerAddressesWorkflow delete: operationId: DeleteCustomersIdAddressesAddress_id - summary: Remove Addresses from Customer - description: >- - Remove a list of addresses from a customer. This doesn't delete the Address, - only the association between the Address and the customer. + summary: Remove an Address from Customer + description: Remove a customer's address. x-authenticated: true parameters: - name: id @@ -310,7 +309,7 @@ delete: type: string - name: address_id in: path - description: The customer's address id. + description: The customer address's ID. required: true schema: type: string @@ -421,3 +420,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteCustomerAddressesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml index 87a5beb5b6..dc56780d98 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml @@ -12,61 +12,6 @@ get: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml index 4e15e34b57..ff659d19f6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -213,3 +213,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: beginExchangeOrderWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml index df2fa0100f..7c5739d184 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -100,3 +45,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelOrderExchangeWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml index c1fb34c251..e6b225ca38 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml index 6ef2e5db70..6ba2e9d871 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml @@ -16,61 +16,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -111,10 +56,16 @@ post: x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteExchangesIdInboundItemsAction_id - summary: Remove Items from Exchange - description: >- - Remove a list of items from a exchange. This doesn't delete the Item, only - the association between the Item and the exchange. + summary: Remove Inbound Item from Exchange + x-sidebar-summary: Remove Inbound Item + description: > + Remove an inbound (or return) item from an exchange using the `ID` of the + item's `RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -125,7 +76,7 @@ delete: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the return item's `RETURN_ITEM` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml index 6a18a6232d..99576a4e50 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml index f2e97d6554..0f7794902c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method_{action_id}.yaml @@ -110,11 +110,16 @@ post: x-workflow: updateReturnShippingMethodWorkflow delete: operationId: DeleteExchangesIdInboundShippingMethodAction_id - summary: Remove Shipping Methods from Exchange - description: >- - Remove a list of shipping methods from a exchange. This doesn't delete the - Shipping Method, only the association between the Shipping Method and the - exchange. + summary: Remove Inbound Shipping Method from Exchange + x-sidebar-summary: Remove Inbound Shipping Method + description: > + Remove the shipping method for returning items in the exchange using the + `ID` of the method's `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -125,65 +130,10 @@ delete: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml index f2bbd76f9d..303f0ba2fd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_items_{action_id}.yaml @@ -110,10 +110,16 @@ post: x-workflow: updateExchangeAddItemWorkflow delete: operationId: DeleteExchangesIdOutboundItemsAction_id - summary: Remove Items from Exchange - description: >- - Remove a list of items from a exchange. This doesn't delete the Item, only - the association between the Item and the exchange. + summary: Remove Outbound Item from Exchange + x-sidebar-summary: Remove Outbound Item + description: > + Remove an outbound (or new) item from an exchange using the `ID` of the + item's `ITEM_ADD` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -124,7 +130,7 @@ delete: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the new exchange item's `ITEM_ADD` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml index c552a88893..1816097d13 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_outbound_shipping-method_{action_id}.yaml @@ -110,11 +110,16 @@ post: x-workflow: updateExchangeShippingMethodWorkflow delete: operationId: DeleteExchangesIdOutboundShippingMethodAction_id - summary: Remove Shipping Methods from Exchange - description: >- - Remove a list of shipping methods from a exchange. This doesn't delete the - Shipping Method, only the association between the Shipping Method and the - exchange. + summary: Remove Outbound Shipping Method from Exchange + x-sidebar-summary: Remove Outbound Shipping Method + description: > + Remove the shipping method for delivering outbound items in the exchange + using the `ID` of the method's `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -125,7 +130,7 @@ delete: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml index d7fa0e3737..e93149966c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml @@ -102,10 +102,8 @@ post: schema: {} delete: operationId: DeleteExchangesIdRequest - summary: Remove Requests from Exchange - description: >- - Remove a list of requests from a exchange. This doesn't delete the Request, - only the association between the Request and the exchange. + summary: Cancel Exchange Request + description: Cancel a requested exchange. x-authenticated: true parameters: - name: id @@ -114,61 +112,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -200,11 +143,12 @@ delete: object: type: string title: object - description: The exchange's object. + description: The name of the deleted object. + default: exchange deleted: type: boolean title: deleted - description: The exchange's deleted. + description: Whether the exchange was deleted. parent: type: object description: The exchange's parent. @@ -220,3 +164,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelBeginOrderExchangeWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml index b5f01ac9d9..966ac62862 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml @@ -79,7 +79,7 @@ get: - name: is_enabled in: query description: The fulfillment provider's is enabled. - required: true + required: false schema: type: boolean title: is_enabled diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml index 8ac943e8a4..212c231cab 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml @@ -1,6 +1,6 @@ delete: operationId: DeleteFulfillmentSetsId - summary: Delete a Fulfillment Set + summary: Delete Fulfillment Set description: Delete a fulfillment set. x-authenticated: true parameters: @@ -10,61 +10,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -95,3 +40,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteFulfillmentSetsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml index 05373cd993..109f6ffc8f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml @@ -215,3 +215,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createServiceZonesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml index 22d628afff..59283fed8a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml @@ -344,13 +344,12 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateServiceZonesWorkflow delete: operationId: DeleteFulfillmentSetsIdServiceZonesZone_id - summary: Remove Service Zones from Fulfillment Set - description: >- - Remove a list of service zones from a fulfillment set. This doesn't delete - the Service Zone, only the association between the Service Zone and the - fulfillment set. + summary: Remove a Service Zone from Fulfillment Set + x-sidebar-summary: Remove Service Zone + description: Remove a service zone that belongs to a fulfillment set. x-authenticated: true parameters: - name: id @@ -361,65 +360,10 @@ delete: type: string - name: zone_id in: path - description: The fulfillment set's zone id. + description: The service zone's ID. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -448,18 +392,19 @@ delete: id: type: string title: id - description: The fulfillment set's ID. + description: The service zone's ID. object: type: string title: object - description: The fulfillment set's object. + description: The name of the deleted object. + default: service_zone deleted: type: boolean title: deleted - description: The fulfillment set's deleted. + description: Whether the service zone was deleted. parent: type: object - description: The fulfillment set's parent. + description: The fulfillment set that the service zone belongs to. '400': $ref: ../components/responses/400_error.yaml '401': @@ -472,3 +417,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteServiceZonesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml index c10190ccd7..79321c728a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml @@ -100,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelFulfillmentWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml index 19f8001ff2..aaadf584fe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml @@ -100,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createShipmentWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml index 227b09cd80..64afe35e58 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml @@ -156,7 +156,7 @@ get: - name: requires_shipping in: query description: The inventory item's requires shipping. - required: true + required: false schema: type: boolean title: requires_shipping diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml index cd8eed4249..43c436adb6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml @@ -270,10 +270,11 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateInventoryItemsWorkflow delete: operationId: DeleteInventoryItemsId - summary: Delete a Inventory Item - description: Delete a inventory item. + summary: Delete Inventory Item + description: Delete an inventory item. x-authenticated: true parameters: - name: id @@ -282,61 +283,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -368,11 +314,12 @@ delete: object: type: string title: object - description: The inventory item's object. + description: The name of the deleted object. + default: inventory_item deleted: type: boolean title: deleted - description: The inventory item's deleted. + description: Whether the inventory item was deleted. parent: type: object description: The inventory item's parent. @@ -388,3 +335,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteInventoryItemWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index bdc1f5cf36..0043e9778b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -279,3 +279,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createInventoryLevelsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml index cf048f0752..88399ca32d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -153,3 +98,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: bulkCreateDeleteLevelsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml index 55884790df..db60f216cd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml @@ -117,13 +117,17 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateInventoryLevelsWorkflow delete: operationId: DeleteInventoryItemsIdLocationLevelsLocation_id - summary: Remove Location Levels from Inventory Item - description: >- - Remove a list of location levels from a inventory item. This doesn't delete - the Location Level, only the association between the Location Level and the - inventory item. + summary: Remove Inventory Level of Inventory Item + x-sidebar-summary: Remove Inventory Level + description: > + Remove the inventory level of an inventory item. + + + If the inventory level has reserved quantity greater than `0`, an error is + thrown. x-authenticated: true parameters: - name: id @@ -221,18 +225,19 @@ delete: id: type: string title: id - description: The inventory item's ID. + description: The inventory level's ID. object: type: string title: object - description: The inventory item's object. + description: The name of the deleted object. + default: inventory-level deleted: type: boolean title: deleted - description: The inventory item's deleted. + description: Whether the inventory level was deleted. parent: type: object - description: The inventory item's parent. + description: The inventory item of the level. '400': $ref: ../components/responses/400_error.yaml '401': @@ -245,3 +250,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteInventoryLevelsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml index 67f8ff541a..6f5d2cdd8b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -103,104 +103,17 @@ get: in: query description: The invite's created at. required: false - schema: - type: string - description: The invite's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The invite's updated at. required: false - schema: - type: string - description: The invite's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The invite's deleted at. required: false - schema: - type: string - description: The invite's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -375,3 +288,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createInvitesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml index 2f4a899477..b16dd3aacd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml @@ -125,3 +125,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: acceptInviteWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml index 48affe3365..d64a3e8b34 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml @@ -95,8 +95,8 @@ get: $ref: ../components/responses/500_error.yaml delete: operationId: DeleteInvitesId - summary: Delete a Invite - description: Delete a invite. + summary: Delete Invite + description: Delete an invite. x-authenticated: false parameters: - name: id @@ -105,61 +105,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. x-codeSamples: - lang: Shell label: cURL @@ -187,11 +132,12 @@ delete: object: type: string title: object - description: The invite's object. + description: The name of the deleted object. + default: invite deleted: type: boolean title: deleted - description: The invite's deleted. + description: Whether the invite was deleted. parent: type: object description: The invite's parent. @@ -207,3 +153,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteInvitesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml index 21cd7d77ac..52cf947d6b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml @@ -95,3 +95,4 @@ post: content: application/json: schema: {} + x-workflow: refreshInviteTokensWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml index 9de582d632..e899fbcce1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml @@ -3,62 +3,7 @@ post: summary: Create Order Edit description: Create a order edit. x-authenticated: true - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] security: - api_token: [] - cookie_auth: [] @@ -94,3 +39,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: beginOrderEditOrderWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml index 0b23979f0e..9a2d2b2eae 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml @@ -1,7 +1,7 @@ delete: operationId: DeleteOrderEditsId - summary: Delete a Order Edit - description: Delete a order edit. + summary: Cancel Order Edit + description: Cancel an order edit. x-authenticated: true parameters: - name: id @@ -10,61 +10,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -96,11 +41,12 @@ delete: object: type: string title: object - description: The order edit's object. + description: The name of the deleted object. + default: order-edit deleted: type: boolean title: deleted - description: The order edit's deleted. + description: Whether the order edit was deleted. parent: type: object description: The order edit's parent. @@ -116,3 +62,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelBeginOrderEditWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml index a99c068940..8cb0690452 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml index 624cb2c2ab..faebb09175 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml index b4370eb7a0..33c006c862 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml @@ -16,61 +16,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml index 40993c5ed7..4ba204ddd5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml @@ -16,61 +16,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -109,10 +54,16 @@ post: x-workflow: updateOrderEditAddItemWorkflow delete: operationId: DeleteOrderEditsIdItemsAction_id - summary: Remove Items from Order Edit - description: >- - Remove a list of items from a order edit. This doesn't delete the Item, only - the association between the Item and the order edit. + summary: Remove Item from Order Edit + x-sidebar-summary: Remove Item + description: > + Remove an added item in the order edit by the ID of the item's `ITEM_ADD` + action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -123,65 +74,10 @@ delete: type: string - name: action_id in: path - description: The order edit's action id. + description: The ID of the new item's `ITEM_ADD` action. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml index 9647702d07..59d10f6234 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml index 57646206d5..bd056e0fd4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml index fbe0391b82..05666b927a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml @@ -16,61 +16,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -111,11 +56,16 @@ post: x-workflow: updateOrderEditShippingMethodWorkflow delete: operationId: DeleteOrderEditsIdShippingMethodAction_id - summary: Remove Shipping Methods from Order Edit - description: >- - Remove a list of shipping methods from a order edit. This doesn't delete the - Shipping Method, only the association between the Shipping Method and the - order edit. + summary: Remove Shipping Method from Order Edit + x-sidebar-summary: Remove Shipping Method + description: > + Remove a shipping method in the order edit by the ID of the method's + `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -126,65 +76,10 @@ delete: type: string - name: action_id in: path - description: The order edit's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml index fff67acdc9..00c1debacd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -120,3 +120,4 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: getOrdersListWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml index 62c40450f5..d71bb42cc3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -97,6 +97,7 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: getOrderDetailWorkflow post: operationId: PostOrdersId summary: Update a Order diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml index aa4f9fdab9..48cecea993 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml @@ -100,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: archiveOrderWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml index a21986ff6b..d3918e424d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml @@ -99,3 +99,4 @@ post: content: application/json: schema: {} + x-workflow: cancelOrderWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml new file mode 100644 index 0000000000..8dacb2f2ef --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml @@ -0,0 +1,97 @@ +get: + 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. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + 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 `-`. + required: false + schema: + 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 `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}_changes/get.sh + tags: + - Orders + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderChangesResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml index ba7bf7255c..d8165dc12c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml @@ -119,3 +119,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: completeOrderWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml index dbd891d43d..e2313491c5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml @@ -146,3 +146,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createOrderFulfillmentWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml index 721490c218..e628da9a10 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -124,3 +124,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelOrderFulfillmentWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml index afd3b98810..f941fcbb26 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml @@ -171,3 +171,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createOrderShipmentWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml index 0118ccce36..b47d44ed92 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_preview.yaml @@ -12,61 +12,6 @@ get: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml index 11488e31be..0691343935 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml @@ -10,61 +10,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -96,11 +41,12 @@ delete: object: type: string title: object - description: The payment collection's object. + description: The name of the deleted object. + default: payment-collection deleted: type: boolean title: deleted - description: The payment collection's deleted. + description: Whether the payment collection was deleted. parent: type: object description: The payment collection's parent. @@ -116,3 +62,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteOrderPaymentCollections diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml index ec4c68bfc1..c8aff72572 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml @@ -109,3 +109,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: markPaymentCollectionAsPaid diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml index f4df65e099..55ef2c0f5b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -101,104 +101,17 @@ get: in: query description: The payment's created at. required: false - schema: - type: string - description: The payment's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The payment's updated at. required: false - schema: - type: string - description: The payment's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The payment's deleted at. required: false - schema: - type: string - description: The payment's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml index 2bf18d8e29..03bcd9accd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml @@ -106,3 +106,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: capturePaymentWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml index 69da43ac26..cd87b7c6eb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml @@ -114,3 +114,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: refundPaymentWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml index fce1c9e946..63fa45804a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml @@ -187,3 +187,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createPriceListsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml index 6ed548eb3e..51104dc970 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml @@ -199,6 +199,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updatePriceListsWorkflow delete: operationId: DeletePriceListsId summary: Delete a Price List @@ -211,61 +212,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -296,3 +242,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deletePriceListsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml index 18d2550acc..5942624903 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -184,3 +129,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchPriceListPricesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml index 43c8dd3e92..9bb3848e4f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml @@ -116,3 +116,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchPriceListPricesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml index 13f395aa9c..77dbe8ed0e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml @@ -188,3 +188,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createPricePreferencesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml index 28a16d7797..a78da610b0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml @@ -199,6 +199,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updatePricePreferencesWorkflow delete: operationId: DeletePricePreferencesId summary: Delete a Price Preference @@ -211,61 +212,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -296,3 +242,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deletePricePreferencesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index 248733e68f..4e75732886 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -129,7 +129,7 @@ get: - name: include_ancestors_tree in: query description: The product category's include ancestors tree. - required: true + required: false schema: type: boolean title: include_ancestors_tree @@ -137,7 +137,7 @@ get: - name: include_descendants_tree in: query description: The product category's include descendants tree. - required: true + required: false schema: type: boolean title: include_descendants_tree @@ -145,7 +145,7 @@ get: - name: is_internal in: query description: The product category's is internal. - required: true + required: false schema: type: boolean title: is_internal @@ -153,7 +153,7 @@ get: - name: is_active in: query description: The product category's is active. - required: true + required: false schema: type: boolean title: is_active @@ -162,104 +162,17 @@ get: in: query description: The product category's created at. required: false - schema: - type: string - description: The product category's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The product category's updated at. required: false - schema: - type: string - description: The product category's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The product category's deleted at. required: false - schema: - type: string - description: The product category's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml index ba99ddfeff..1ea884f1ef 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -70,7 +70,7 @@ get: - name: include_ancestors_tree in: query description: The product category's include ancestors tree. - required: true + required: false schema: type: boolean title: include_ancestors_tree @@ -78,7 +78,7 @@ get: - name: include_descendants_tree in: query description: The product category's include descendants tree. - required: true + required: false schema: type: boolean title: include_descendants_tree @@ -251,10 +251,11 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateProductCategoriesWorkflow delete: operationId: DeleteProductCategoriesId summary: Delete a Product Category - description: Delete a product category. + description: Delete a product category. This doesn't deleted products in that category. x-authenticated: true parameters: - name: id @@ -263,61 +264,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -348,3 +294,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteProductCategoriesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml index 901739002a..3b4b24a868 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml @@ -116,3 +116,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchLinkProductsToCategoryWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml index edc68d2488..c5c9d1bccf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml @@ -101,104 +101,17 @@ get: in: query description: The product tag's created at. required: false - schema: - type: string - description: The product tag's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The product tag's updated at. required: false - schema: - type: string - description: The product tag's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The product tag's deleted at. required: false - schema: - type: string - description: The product tag's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml index 222f8c1923..0b9d31cb82 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml @@ -214,7 +214,7 @@ post: delete: operationId: DeleteProductTagsId summary: Delete a Product Tag - description: Delete a product tag. + description: Delete a product tag. This doesn't delete products using the tag. x-authenticated: true parameters: - name: id @@ -223,61 +223,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -308,3 +253,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteProductTagsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml index 51a008a784..c9e49b0ba9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml @@ -101,104 +101,17 @@ get: in: query description: The product type's created at. required: false - schema: - type: string - description: The product type's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The product type's updated at. required: false - schema: - type: string - description: The product type's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The product type's deleted at. required: false - schema: - type: string - description: The product type's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml index 6652866393..cc43d777ba 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml @@ -214,7 +214,7 @@ post: delete: operationId: DeleteProductTypesId summary: Delete a Product Type - description: Delete a product type. + description: Delete a product type. This doesn't delete products of this type. x-authenticated: true parameters: - name: id @@ -223,61 +223,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -308,3 +253,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteProductTypesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index 8fc8ca27fc..d9d7b11035 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -4418,1867 +4418,211 @@ get: type: array description: The created at's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. + type: object $or: type: array description: The created at's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. + type: object $eq: oneOf: - type: string title: $eq - description: The created at's $eq. - - type: object - description: The created at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + description: Filter by an exact match. - type: array - description: The created at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The created at's $ne. - - type: object - description: The created at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. + type: string + title: $ne $in: type: array description: The created at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. + type: string + title: $in $nin: type: array description: The created at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The created at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The created at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The created at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: array - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: >- + Filter arrays that have overlapping values with this + parameter. items: type: string title: $overlap - description: The $overlap's details. + description: >- + Filter arrays that have overlapping values with this + parameter. $contains: type: array - description: The $not's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. items: type: string title: $contains - description: The $contain's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: >- + Filter by whether a value for this parameter exists (not + `null`). - type: array - description: The created at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The created at's $gt. - - type: object - description: The created at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The created at's $gte. - - type: object - description: The created at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The created at's $lt. - - type: object - description: The created at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The created at's $lte. - - type: object - description: The created at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. + type: string + title: $lte $like: type: string title: $like @@ -6332,1867 +4676,211 @@ get: type: array description: The updated at's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. + type: object $or: type: array description: The updated at's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. + type: object $eq: oneOf: - type: string title: $eq - description: The updated at's $eq. - - type: object - description: The updated at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + description: Filter by an exact match. - type: array - description: The updated at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The updated at's $ne. - - type: object - description: The updated at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. + type: string + title: $ne $in: type: array description: The updated at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. + type: string + title: $in $nin: type: array description: The updated at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The updated at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The updated at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The updated at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: array - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: >- + Filter arrays that have overlapping values with this + parameter. items: type: string title: $overlap - description: The $overlap's details. + description: >- + Filter arrays that have overlapping values with this + parameter. $contains: type: array - description: The $not's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. items: type: string title: $contains - description: The $contain's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: >- + Filter by whether a value for this parameter exists (not + `null`). - type: array - description: The updated at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The updated at's $gt. - - type: object - description: The updated at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The updated at's $gte. - - type: object - description: The updated at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The updated at's $lt. - - type: object - description: The updated at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The updated at's $lte. - - type: object - description: The updated at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. + type: string + title: $lte $like: type: string title: $like @@ -8246,1867 +4934,211 @@ get: type: array description: The deleted at's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1128: - type: object - description: The $and's @match@1128. - __@replace@1130: - type: object - description: The $and's @replace@1130. - __@search@1133: - type: object - description: The $and's @search@1133. - __@split@1135: - type: object - description: The $and's @split@1135. - __@matchAll@1137: - type: object - description: The $and's @matchall@1137. + type: object $or: type: array description: The deleted at's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1128: - type: object - description: The $or's @match@1128. - __@replace@1130: - type: object - description: The $or's @replace@1130. - __@search@1133: - type: object - description: The $or's @search@1133. - __@split@1135: - type: object - description: The $or's @split@1135. - __@matchAll@1137: - type: object - description: The $or's @matchall@1137. + type: object $eq: oneOf: - type: string title: $eq - description: The deleted at's $eq. - - type: object - description: The deleted at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + description: Filter by an exact match. - type: array - description: The deleted at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1128: - type: object - description: The $eq's @match@1128. - __@replace@1130: - type: object - description: The $eq's @replace@1130. - __@search@1133: - type: object - description: The $eq's @search@1133. - __@split@1135: - type: object - description: The $eq's @split@1135. - __@matchAll@1137: - type: object - description: The $eq's @matchall@1137. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The deleted at's $ne. - - type: object - description: The deleted at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1128: - type: object - description: The $ne's @match@1128. - __@replace@1130: - type: object - description: The $ne's @replace@1130. - __@search@1133: - type: object - description: The $ne's @search@1133. - __@split@1135: - type: object - description: The $ne's @split@1135. - __@matchAll@1137: - type: object - description: The $ne's @matchall@1137. + type: string + title: $ne $in: type: array description: The deleted at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1128: - type: object - description: The $in's @match@1128. - __@replace@1130: - type: object - description: The $in's @replace@1130. - __@search@1133: - type: object - description: The $in's @search@1133. - __@split@1135: - type: object - description: The $in's @split@1135. - __@matchAll@1137: - type: object - description: The $in's @matchall@1137. + type: string + title: $in $nin: type: array description: The deleted at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1128: - type: object - description: The $nin's @match@1128. - __@replace@1130: - type: object - description: The $nin's @replace@1130. - __@search@1133: - type: object - description: The $nin's @search@1133. - __@split@1135: - type: object - description: The $nin's @split@1135. - __@matchAll@1137: - type: object - description: The $nin's @matchall@1137. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The deleted at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The deleted at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. - - type: object - description: The deleted at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: string - title: $and - description: The $and's details. - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: string - title: $or - description: The $or's details. - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: array - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: >- + Filter arrays that have overlapping values with this + parameter. items: type: string title: $overlap - description: The $overlap's details. + description: >- + Filter arrays that have overlapping values with this + parameter. $contains: type: array - description: The $not's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. items: type: string title: $contains - description: The $contain's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: >- + Filter by whether a value for this parameter exists (not + `null`). - type: array - description: The deleted at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1128: - type: object - description: The $not's @match@1128. - __@replace@1130: - type: object - description: The $not's @replace@1130. - __@search@1133: - type: object - description: The $not's @search@1133. - __@split@1135: - type: object - description: The $not's @split@1135. - __@matchAll@1137: - type: object - description: The $not's @matchall@1137. + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The deleted at's $gt. - - type: object - description: The deleted at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1128: - type: object - description: The $gt's @match@1128. - __@replace@1130: - type: object - description: The $gt's @replace@1130. - __@search@1133: - type: object - description: The $gt's @search@1133. - __@split@1135: - type: object - description: The $gt's @split@1135. - __@matchAll@1137: - type: object - description: The $gt's @matchall@1137. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The deleted at's $gte. - - type: object - description: The deleted at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1128: - type: object - description: The $gte's @match@1128. - __@replace@1130: - type: object - description: The $gte's @replace@1130. - __@search@1133: - type: object - description: The $gte's @search@1133. - __@split@1135: - type: object - description: The $gte's @split@1135. - __@matchAll@1137: - type: object - description: The $gte's @matchall@1137. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The deleted at's $lt. - - type: object - description: The deleted at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1128: - type: object - description: The $lt's @match@1128. - __@replace@1130: - type: object - description: The $lt's @replace@1130. - __@search@1133: - type: object - description: The $lt's @search@1133. - __@split@1135: - type: object - description: The $lt's @split@1135. - __@matchAll@1137: - type: object - description: The $lt's @matchall@1137. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The deleted at's $lte. - - type: object - description: The deleted at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1128 - - __@replace@1130 - - __@search@1133 - - __@matchAll@1137 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1128: - type: object - description: The $lte's @match@1128. - __@replace@1130: - type: object - description: The $lte's @replace@1130. - __@search@1133: - type: object - description: The $lte's @search@1133. - __@split@1135: - type: object - description: The $lte's @split@1135. - __@matchAll@1137: - type: object - description: The $lte's @matchall@1137. + type: string + title: $lte $like: type: string title: $like @@ -10156,10 +5188,8 @@ get: type: array description: The product's $and. items: - type: array - items: - type: object - title: $and + type: object + title: $and - name: $or in: query description: The product's $or. @@ -10168,10 +5198,8 @@ get: type: array description: The product's $or. items: - type: array - items: - type: object - title: $or + type: object + title: $or security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml index 7e68dc7f07..2a53548263 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml @@ -3,62 +3,7 @@ post: summary: Create Product description: Create a product. x-authenticated: true - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml index d860ea257b..f9f1b35151 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -94,3 +39,4 @@ post: content: application/json: schema: {} + x-workflow: importProductsWorkflowId diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml index 952048838a..db8086d3fe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml @@ -223,61 +223,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -308,3 +253,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteProductsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml index f04c2439ae..009f4f674d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml @@ -125,10 +125,8 @@ get: type: array description: The product's $and. items: - type: array - items: - type: object - title: $and + type: object + title: $and - name: $or in: query description: The product's $or. @@ -137,10 +135,8 @@ get: type: array description: The product's $or. items: - type: array - items: - type: object - title: $or + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -313,3 +309,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createProductOptionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml index b7c256b32a..6e406d38b5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml @@ -222,12 +222,15 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateProductOptionsWorkflow delete: operationId: DeleteProductsIdOptionsOption_id - summary: Remove Options from Product - description: >- - Remove a list of options from a product. This doesn't delete the Option, - only the association between the Option and the product. + summary: Delete an Option from Product + x-sidebar-summary: Delete Option + description: | + Delete an option from a product. + + Values of this option in the product's variants are removed. x-authenticated: true parameters: - name: id @@ -238,7 +241,7 @@ delete: type: string - name: option_id in: path - description: The product's option id. + description: The product option's ID. required: true schema: type: string @@ -328,3 +331,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteProductOptionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index 6e1f8f0735..ca72ba095c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -239,3 +239,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createProductVariantsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml index f7c918a372..f8152e5d3f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml index 230c236c64..4fd627635d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml @@ -223,12 +223,12 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateProductVariantsWorkflow delete: operationId: DeleteProductsIdVariantsVariant_id - summary: Remove Variants from Product - description: >- - Remove a list of variants from a product. This doesn't delete the Variant, - only the association between the Variant and the product. + summary: Delete Product Variant + x-sidebar-summary: Delete Variant + description: Delete a variant of a product. x-authenticated: true parameters: - name: id @@ -239,7 +239,7 @@ delete: type: string - name: variant_id in: path - description: The product's variant id. + description: The product variant's ID. required: true schema: type: string @@ -329,3 +329,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteProductVariantsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml index 8f04ccd950..876e009554 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml @@ -107,3 +107,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createLinksWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml index 52d09f114b..5cb1c3a0c8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml @@ -113,13 +113,12 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateLinksWorkflow delete: operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id - summary: Remove Inventory Items from Product - description: >- - Remove a list of inventory items from a product. This doesn't delete the - Inventory Item, only the association between the Inventory Item and the - product. + summary: Remove Inventory Item Association with Product Variant + x-sidebar-summary: Remove Inventory Item + description: Remove the association between an inventory item and its product variant. x-authenticated: true parameters: - name: id @@ -130,13 +129,13 @@ delete: type: string - name: variant_id in: path - description: The product's variant id. + description: The products variant's ID. required: true schema: type: string - name: inventory_item_id in: path - description: The product's inventory item id. + description: The inventory item's ID. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index 829064096b..9e7b1810e9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -120,104 +120,17 @@ get: in: query description: The promotion's created at. required: false - schema: - type: string - description: The promotion's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The promotion's updated at. required: false - schema: - type: string - description: The promotion's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The promotion's deleted at. required: false - schema: - type: string - description: The promotion's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -669,3 +582,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createPromotionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml index 5ab97bbb47..d45d27ef03 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml @@ -13,61 +13,6 @@ get: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - name: promotion_type in: query description: The promotion's promotion type. diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml index 08a9ba7f51..1f207b542e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml @@ -471,6 +471,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updatePromotionsWorkflow delete: operationId: DeletePromotionsId summary: Delete a Promotion @@ -483,61 +484,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -569,11 +515,12 @@ delete: object: type: string title: object - description: The promotion's object. + description: The name of the deleted object. + default: promotion deleted: type: boolean title: deleted - description: The promotion's deleted. + description: Whether the promotion was deleted. parent: type: object description: The promotion's parent. @@ -589,3 +536,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deletePromotionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml index f5b922afda..0d5fb886b4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml @@ -211,6 +211,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateRefundReasonsWorkflow delete: operationId: DeleteRefundReasonsId summary: Delete a Refund Reason @@ -223,61 +224,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -309,11 +255,12 @@ delete: object: type: string title: object - description: The refund reason's object. + description: The name of the deleted object. + default: refund_reason deleted: type: boolean title: deleted - description: The refund reason's deleted. + description: Whether the refund reason was deleted. parent: type: object description: The refund reason's parent. @@ -329,3 +276,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteReturnReasonsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml index a786cad8b2..1b25d3ceaf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -115,104 +115,17 @@ get: in: query description: The region's created at. required: false - schema: - type: string - description: The region's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The region's updated at. required: false - schema: - type: string - description: The region's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The region's deleted at. required: false - schema: - type: string - description: The region's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml index 1c3a700afb..548e50929b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml @@ -249,61 +249,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -335,11 +280,12 @@ delete: object: type: string title: object - description: The region's object. + description: The name of the deleted object. + default: region deleted: type: boolean title: deleted - description: The region's deleted. + description: Whether the region was deleted. parent: type: object description: The region's parent. @@ -355,3 +301,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteRegionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml index c962aac96f..10ccadb65d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -189,104 +189,17 @@ get: in: query description: The reservation's created at. required: false - schema: - type: string - description: The reservation's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The reservation's updated at. required: false - schema: - type: string - description: The reservation's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The reservation's deleted at. required: false - schema: - type: string - description: The reservation's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml index 6475969caa..a6b197aeda 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml @@ -219,6 +219,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateReservationsWorkflow delete: operationId: DeleteReservationsId summary: Delete a Reservation @@ -231,61 +232,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -317,11 +263,12 @@ delete: object: type: string title: object - description: The reservation's object. + description: The name of the deleted object. + default: reservation deleted: type: boolean title: deleted - description: The reservation's deleted. + description: Whether the reservation was deleted. parent: type: object description: The reservation's parent. @@ -337,3 +284,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteReservationsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml index cef409643a..8e43cb2c81 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml @@ -143,29 +143,17 @@ get: in: query description: The return reason's created at. required: false - schema: - type: string - format: date-time - title: created_at - description: The return reason's created at. + schema: {} - name: updated_at in: query description: The return reason's updated at. required: false - schema: - type: string - format: date-time - title: updated_at - description: The return reason's updated at. + schema: {} - name: deleted_at in: query description: The return reason's deleted at. required: false - schema: - type: string - format: date-time - title: deleted_at - description: The return reason's deleted at. + schema: {} - name: $and in: query description: The return reason's $and. @@ -312,3 +300,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createReturnReasonsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml index ff3975be47..87ca025fb9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml @@ -199,6 +199,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateReturnReasonsWorkflow delete: operationId: DeleteReturnReasonsId summary: Delete a Return Reason @@ -211,61 +212,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -297,11 +243,12 @@ delete: object: type: string title: object - description: The return reason's object. + description: The name of the deleted object. + default: return_reason deleted: type: boolean title: deleted - description: The return reason's deleted. + description: Whether the return reason was deleted. parent: type: object description: The return reason's parent. @@ -317,3 +264,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteReturnReasonsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml index c05930614a..39be2f7f9c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -216,3 +216,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: beginReturnOrderWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml index 4a1f51068c..c6d72608d4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -100,3 +45,4 @@ post: application/json: schema: $ref: ../components/schemas/AdminPostCancelReturnReqSchema.yaml + x-workflow: cancelReturnWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml index 1303256ea2..5248bdaf4a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml @@ -111,10 +111,16 @@ post: x-workflow: updateReceiveItemReturnRequestWorkflow delete: operationId: DeleteReturnsIdDismissItemsAction_id - summary: Remove Dismiss Items from Return - description: >- - Remove a list of dismiss items from a return. This doesn't delete the - Dismiss Item, only the association between the Dismiss Item and the return. + summary: Remove Damaged Item from Return + x-sidebar-summary: Remove Damaged Item + description: > + Remove a damaged item, whose quantity is to be dismissed, in the return by + the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -125,7 +131,7 @@ delete: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml index 9ea624fb9e..50f3cc6dfe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml @@ -111,10 +111,16 @@ post: x-workflow: updateReceiveItemReturnRequestWorkflow delete: operationId: DeleteReturnsIdReceiveItemsAction_id - summary: Remove Receive Items from Return - description: >- - Remove a list of receive items from a return. This doesn't delete the - Receive Item, only the association between the Receive Item and the return. + summary: Remove a Received Item from Return + x-sidebar-summary: Remove Received Item + description: > + Remove an item marked as received in the return by the ID of the item's + `RECEIVE_RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -125,7 +131,7 @@ delete: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the received item's `RECEIVE_RETURN_ITEM` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index 7339dcacae..c97503f988 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml @@ -100,12 +100,13 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: beginReceiveReturnWorkflow delete: operationId: DeleteReturnsIdReceive - summary: Remove Receives from Return + summary: Cancel Return Receival description: >- - Remove a list of receives from a return. This doesn't delete the Receive, - only the association between the Receive and the return. + Cancel the receival process previously started, and hasn't been confirmed, + of a return. x-authenticated: true parameters: - name: id @@ -114,61 +115,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -200,11 +146,12 @@ delete: object: type: string title: object - description: The return's object. + description: The name of the returned object. + default: return deleted: type: boolean title: deleted - description: The return's deleted. + description: Whether the return was deleted. parent: type: object description: The return's parent. @@ -220,3 +167,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelReturnReceiveWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml index 77880a4016..3f527ba2da 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request-items_{action_id}.yaml @@ -111,10 +111,15 @@ post: x-workflow: updateRequestItemReturnWorkflow delete: operationId: DeleteReturnsIdRequestItemsAction_id - summary: Remove Request Items from Return - description: >- - Remove a list of request items from a return. This doesn't delete the - Request Item, only the association between the Request Item and the return. + summary: Remove Item from Return + x-sidebar-summary: Remove Item + description: > + Remove an item in the return by the ID of the item's `RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -125,7 +130,7 @@ delete: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the item's `RETURN_ITEM` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml index 472cc54ad3..dae1bff6dc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml @@ -103,10 +103,8 @@ post: x-workflow: confirmReturnRequestWorkflow delete: operationId: DeleteReturnsIdRequest - summary: Remove Requests from Return - description: >- - Remove a list of requests from a return. This doesn't delete the Request, - only the association between the Request and the return. + summary: Cancel Return Request + description: Cancel a requested return. x-authenticated: true parameters: - name: id @@ -115,61 +113,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -201,11 +144,12 @@ delete: object: type: string title: object - description: The return's object. + description: The name of the deleted object. + default: return deleted: type: boolean title: deleted - description: The return's deleted. + description: Whether the return was deleted. parent: type: object description: The return's parent. @@ -221,3 +165,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: cancelReturnRequestWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml index f7c43e58ca..3394dcecbe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml @@ -108,7 +108,7 @@ get: - name: is_disabled in: query description: The sales channel's is disabled. - required: true + required: false schema: type: boolean title: is_disabled @@ -117,104 +117,17 @@ get: in: query description: The sales channel's created at. required: false - schema: - type: string - description: The sales channel's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The sales channel's updated at. required: false - schema: - type: string - description: The sales channel's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The sales channel's deleted at. required: false - schema: - type: string - description: The sales channel's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: location_id in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml index 51ef07e35e..3522451fc8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml @@ -199,6 +199,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateSalesChannelsWorkflow delete: operationId: DeleteSalesChannelsId summary: Delete a Sales Channel @@ -211,61 +212,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -296,3 +242,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteSalesChannelsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml index a17dbddb34..c55279186d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml @@ -116,3 +116,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: linkProductsToSalesChannelWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml index a169bf593d..259591cfb2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml @@ -143,104 +143,17 @@ get: in: query description: The shipping option's created at. required: false - schema: - type: string - description: The shipping option's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The shipping option's updated at. required: false - schema: - type: string - description: The shipping option's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The shipping option's deleted at. required: false - schema: - type: string - description: The shipping option's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: stock_location_id in: query required: false @@ -534,3 +447,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createShippingOptionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml index a02e0869ed..62bbbfefd8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml @@ -253,6 +253,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateShippingOptionsWorkflow delete: operationId: DeleteShippingOptionsId summary: Delete a Shipping Option @@ -265,61 +266,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -350,3 +296,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteShippingOptionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml index 0891e250aa..25455f6e98 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml @@ -104,104 +104,17 @@ get: in: query description: The shipping profile's created at. required: false - schema: - type: string - description: The shipping profile's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The shipping profile's updated at. required: false - schema: - type: string - description: The shipping profile's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The shipping profile's deleted at. required: false - schema: - type: string - description: The shipping profile's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml index f80ae5be79..a35d68aa76 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml @@ -214,6 +214,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateShippingProfilesWorkflow delete: operationId: DeleteShippingProfilesId summary: Delete a Shipping Profile @@ -226,61 +227,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -311,3 +257,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteShippingProfileWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml index 01ec416d64..e2a7319f53 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml @@ -129,104 +129,17 @@ get: in: query description: The stock location's created at. required: false - schema: - type: string - description: The stock location's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The stock location's updated at. required: false - schema: - type: string - description: The stock location's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The stock location's deleted at. required: false - schema: - type: string - description: The stock location's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml index fede4e7631..3a9e84bdbf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml @@ -199,6 +199,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateStockLocationsWorkflow delete: operationId: DeleteStockLocationsId summary: Delete a Stock Location @@ -211,61 +212,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -296,3 +242,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteStockLocationsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml index caeae35fe9..c211910651 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-providers.yaml @@ -117,3 +117,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: batchLinksWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml index 017d362138..6d641eab67 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml @@ -114,3 +114,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createLocationFulfillmentSetWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml index 3aecd9fe58..4c61790593 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml @@ -117,3 +117,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: linkSalesChannelsToStockLocationWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml index 2def39904b..1648ee0ebd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml @@ -123,104 +123,17 @@ get: in: query description: The tax rate's created at. required: false - schema: - type: string - description: The tax rate's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The tax rate's updated at. required: false - schema: - type: string - description: The tax rate's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The tax rate's deleted at. required: false - schema: - type: string - description: The tax rate's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml index 74c0c076b1..62495a4a61 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml @@ -199,6 +199,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateTaxRatesWorkflow delete: operationId: DeleteTaxRatesId summary: Delete a Tax Rate @@ -211,61 +212,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -296,3 +242,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteTaxRatesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml index d663b16e66..c7ac809c8c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml @@ -100,3 +100,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createTaxRateRulesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml index cfa32dc578..5906af6a84 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml @@ -124,3 +124,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteTaxRateRulesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml index 7a2609496e..2420c98b25 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml @@ -227,104 +227,17 @@ get: in: query description: The tax region's created at. required: false - schema: - type: string - description: The tax region's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The tax region's updated at. required: false - schema: - type: string - description: The tax region's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The tax region's deleted at. required: false - schema: - type: string - description: The tax region's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml index 3945742296..704706ae66 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml @@ -109,61 +109,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -194,3 +139,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteTaxRegionsWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml index 8097a7af8f..fc96d3c521 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml @@ -3,62 +3,7 @@ post: summary: Create Upload description: Create a upload. x-authenticated: true - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml index fbe427a49c..20d3772217 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml @@ -109,61 +109,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] @@ -215,3 +160,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteFilesWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml index dcdd52142b..2ff9af9bd6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml @@ -191,6 +191,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateUsersWorkflow delete: operationId: DeleteUsersId summary: Delete a User @@ -203,61 +204,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. x-codeSamples: - lang: Shell label: cURL @@ -284,3 +230,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteUsersWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml index 4306a96500..70e502e797 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml index 17c04d7288..4f6dbdb548 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml index 316d4f536d..d310282506 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml @@ -10,61 +10,6 @@ post: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml index fbc7959604..62d5318841 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml @@ -13,61 +13,6 @@ get: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml index f3e49b64b4..6693f4007f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml @@ -25,61 +25,6 @@ get: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminApiKey.yaml new file mode 100644 index 0000000000..e51ff4c548 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminApiKey.yaml @@ -0,0 +1,60 @@ +type: object +description: The api key's details. +x-schemaName: AdminApiKey +required: + - id + - token + - redacted + - title + - type + - last_used_at + - created_by + - created_at + - revoked_by + - revoked_at +properties: + id: + type: string + title: id + description: The api key's ID. + token: + type: string + title: token + description: The api key's token. + redacted: + type: string + title: redacted + description: The api key's redacted. + title: + type: string + title: title + description: The api key's title. + type: + type: string + description: The api key's type. + enum: + - secret + - publishable + last_used_at: + type: string + title: last_used_at + description: The api key's last used at. + format: date-time + created_by: + type: string + title: created_by + description: The api key's created by. + created_at: + type: string + format: date-time + title: created_at + description: The api key's created at. + revoked_by: + type: string + title: revoked_by + description: The api key's revoked by. + revoked_at: + type: string + title: revoked_at + description: The api key's revoked at. + format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminApiKeyResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminApiKeyResponse.yaml index 7d07ea15a7..980051356d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminApiKeyResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminApiKeyResponse.yaml @@ -5,4 +5,4 @@ required: - api_key properties: api_key: - $ref: ./ApiKeyResponse.yaml + $ref: ./AdminApiKey.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductResponse.yaml index ed7d417345..697f688c90 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductResponse.yaml @@ -18,7 +18,7 @@ properties: $ref: ./AdminProduct.yaml deleted: type: object - description: The product's deleted. + description: SUMMARY required: - ids - object @@ -34,8 +34,8 @@ properties: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantResponse.yaml index 383fe37898..01dbaa3edd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantResponse.yaml @@ -18,7 +18,7 @@ properties: $ref: ./AdminProductVariant.yaml deleted: type: object - description: The product's deleted. + description: SUMMARY required: - ids - object @@ -34,8 +34,8 @@ properties: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCampaign.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCampaign.yaml new file mode 100644 index 0000000000..4b3d871f8a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCampaign.yaml @@ -0,0 +1,73 @@ +type: object +description: The campaign's details. +x-schemaName: AdminCampaign +required: + - id + - name + - description + - currency + - campaign_identifier + - starts_at + - ends_at + - budget +properties: + id: + type: string + title: id + description: The campaign's ID. + name: + type: string + title: name + description: The campaign's name. + description: + type: string + title: description + description: The campaign's description. + currency: + type: string + title: currency + description: The campaign's currency. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + budget: + type: object + description: The campaign's budget. + required: + - id + - type + - currency_code + - limit + - used + properties: + id: + type: string + title: id + description: The budget's ID. + type: + type: string + description: The budget's type. + enum: + - spend + - usage + currency_code: + type: string + title: currency_code + description: The budget's currency code. + limit: + type: number + title: limit + description: The budget's limit. + used: + type: number + title: used + description: The budget's used. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCampaignResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCampaignResponse.yaml index a7019974cb..60e666717f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCampaignResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCampaignResponse.yaml @@ -5,4 +5,4 @@ required: - campaign properties: campaign: - $ref: ./CampaignResponse.yaml + $ref: ./AdminCampaign.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml index 9eecf34368..c92a30e4e8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml @@ -113,6 +113,7 @@ properties: $ref: ./BasePaymentCollection.yaml payment_status: type: string + description: The claim's payment status. enum: - canceled - not_paid @@ -131,6 +132,7 @@ properties: $ref: ./BaseOrderFulfillment.yaml fulfillment_status: type: string + description: The claim's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml index 3ef16374d2..7262c162bf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The claim's object. + description: The name of the deleted object. default: claim deleted: type: boolean title: deleted - description: The claim's deleted. + description: Whether the Claim was deleted. parent: type: object description: The claim's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml index 7c95f2e8a3..8fb21f0636 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCollectionDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The collection's object. + description: The name of the deleted object. default: collection deleted: type: boolean title: deleted - description: The collection's deleted. + description: Whether the Collection was deleted. parent: type: object description: The collection's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateApiKey.yaml index 1965ae3238..629c62ee00 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateApiKey.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateApiKey.yaml @@ -11,6 +11,7 @@ properties: description: The api key's title. type: type: string + description: The api key's type. enum: - publishable - secret diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml index bc76085c82..a8e62f3999 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml @@ -25,11 +25,13 @@ properties: description: The price list's ends at. status: type: string + description: The price list's status. enum: - active - draft type: type: string + description: The price list's type. enum: - sale - override diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml index 849d38df54..fac1377ff4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml @@ -47,6 +47,7 @@ properties: description: The create's handle. status: type: string + description: The create's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml index 969982fcb4..e10e753851 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml @@ -17,6 +17,7 @@ properties: compensate_input: {} action: type: string + description: The workflows execution's action. enum: - invoke - compensate diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml index 109a755674..d56f162420 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml @@ -114,6 +114,7 @@ properties: $ref: ./BasePaymentCollection.yaml payment_status: type: string + description: The exchange's payment status. enum: - canceled - not_paid @@ -132,6 +133,7 @@ properties: $ref: ./BaseOrderFulfillment.yaml fulfillment_status: type: string + description: The exchange's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml index e21a663cda..e8068b4b01 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The fulfillment set's object. + description: The name of the deleted object. default: fulfillment_set deleted: type: boolean title: deleted - description: The fulfillment set's deleted. + description: Whether the Fulfillment Set was deleted. parent: type: object description: The fulfillment set's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml index 5b81a094fc..f33a0a9aed 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInvite.yaml @@ -34,11 +34,11 @@ properties: description: The invite's metadata. created_at: type: string + format: date-time title: created_at description: The invite's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The invite's updated at. - format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml index 8ac3b682be..e26100a5de 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -100,6 +100,7 @@ properties: $ref: ./BaseOrderShippingMethod.yaml payment_status: type: string + description: The order's payment status. enum: - canceled - not_paid @@ -113,6 +114,7 @@ properties: - requires_action fulfillment_status: type: string + description: The order's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangesResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangesResponse.yaml new file mode 100644 index 0000000000..4f8c9327af --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangesResponse.yaml @@ -0,0 +1,11 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderChangesResponse +required: + - order_changes +properties: + order_changes: + type: array + description: The order's order changes. + items: + $ref: ./BaseOrderChange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml index 4b3f9af0d3..b7b508bb87 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -200,14 +200,14 @@ properties: $ref: ./BaseOrderItemDetail.yaml created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -505,6 +505,7 @@ properties: $ref: ./AdminPaymentCollection.yaml payment_status: type: string + description: The order preview's payment status. enum: - canceled - not_paid @@ -523,6 +524,7 @@ properties: $ref: ./BaseOrderFulfillment.yaml fulfillment_status: type: string + description: The order preview's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml index e58397669a..684b9497bb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml @@ -93,6 +93,7 @@ properties: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml index 537c8a371a..bd2b3450cc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimItemsReqSchema.yaml @@ -22,6 +22,7 @@ properties: description: The item's quantity. reason: type: string + description: The item's reason. enum: - missing_item - wrong_item diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml index 2dbe34cae5..0a3dcc4f9c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -9,6 +9,7 @@ required: properties: type: type: string + description: The claim's type. enum: - refund - replace diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml index ff8ed0bc50..e921b8aa5f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceList.yaml @@ -40,11 +40,13 @@ properties: description: The price list's ends at. status: type: string + description: The price list's status. enum: - draft - active type: type: string + description: The price list's type. enum: - sale - override diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml index f525939ed7..b4cb20eabd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListBatchResponse.yaml @@ -18,7 +18,7 @@ properties: $ref: ./AdminPrice.yaml deleted: type: object - description: The price list's deleted. + description: SUMMARY required: - ids - object @@ -34,8 +34,8 @@ properties: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml index 9fc53869c3..310a95819b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPriceListDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The price list's object. + description: The name of the deleted object. default: price_list deleted: type: boolean title: deleted - description: The price list's deleted. + description: Whether the Price List was deleted. parent: type: object description: The price list's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml index a34e982325..88ad9e74bf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPricePreferenceDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The price preference's object. + description: The name of the deleted object. default: price_preference deleted: type: boolean title: deleted - description: The price preference's deleted. + description: Whether the Price Preference was deleted. parent: type: object description: The price preference's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml index f31c9d51d9..fd29fa661a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -47,7 +47,7 @@ properties: items: $ref: ./AdminProductVariant.yaml type: - type: object + $ref: ./AdminProductType.yaml tags: type: array description: The parent's tags. @@ -59,6 +59,7 @@ properties: description: The parent's title. status: type: string + description: The parent's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml index 750ab66be6..1845f1e5de 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml @@ -40,6 +40,9 @@ properties: type: string title: id description: The category's ID. + metadata: + type: object + description: The category's metadata. created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml index 38c8ca528b..bbccf4934a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The product category's object. + description: The name of the deleted object. default: product_category deleted: type: boolean title: deleted - description: The product category's deleted. + description: Whether the Product Category was deleted. parent: type: object description: The product category's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml index 65b2edf6c2..e254c15d68 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: product deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: type: object description: The product's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml index c67be976b3..d3f1b213af 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml @@ -13,11 +13,11 @@ properties: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: product_option deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml index d723c20219..5304b49c5b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The product tag's object. + description: The name of the deleted object. default: product_tag deleted: type: boolean title: deleted - description: The product tag's deleted. + description: Whether the Product Tag was deleted. parent: type: object description: The product tag's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml new file mode 100644 index 0000000000..a8d58344ea --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml @@ -0,0 +1,35 @@ +type: object +description: The parent's type. +x-schemaName: AdminProductType +required: + - id + - value + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The type's ID. + value: + type: string + title: value + description: The type's value. + created_at: + type: string + format: date-time + title: created_at + description: The type's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The type's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The type's deleted at. + metadata: + type: object + description: The type's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml index dcd995552c..faa54a3337 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The product type's object. + description: The name of the deleted object. default: product_type deleted: type: boolean title: deleted - description: The product type's deleted. + description: Whether the Product Type was deleted. parent: type: object description: The product type's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml index 5e6dfa5a8f..9bf9f9159f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml @@ -23,4 +23,4 @@ properties: type: array description: The product type's product types. items: - $ref: ./AdminProduct.yaml + $ref: ./AdminProductType.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml index 3e74c8b2fb..8daf16a292 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml @@ -5,4 +5,4 @@ required: - product_type properties: product_type: - $ref: ./AdminProduct.yaml + $ref: ./AdminProductType.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml index dc3b12dd34..7663cc2969 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml @@ -13,11 +13,11 @@ properties: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: variant deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml index 3da518f03a..9cf2e1c985 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml @@ -76,10 +76,10 @@ properties: oneOf: - $ref: ./AdminProductVariantInventoryLink.yaml - type: array - description: The product's deleted. + description: SUMMARY items: type: object - description: The deleted's details. + description: SUMMARY x-schemaName: AdminProductVariantInventoryLink required: - productService diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml index 4e2fdc8918..ba2ab976f9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml @@ -12,10 +12,10 @@ properties: object: type: string title: object - description: The product's object. + description: The name of the deleted object. deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: ./AdminProductVariant.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml index 0b6f5fd615..9aca47220c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml @@ -62,17 +62,11 @@ properties: type: array description: The variant's $and. items: - type: array - description: The $and's details. - items: - type: object - title: $and + type: object + title: $and $or: type: array description: The variant's $or. items: - type: array - description: The $or's details. - items: - type: object - title: $or + type: object + title: $or diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml index a04db87818..2a31b4ded7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml @@ -14,6 +14,7 @@ properties: description: The promotion's code. type: type: string + description: The promotion's type. enum: - standard - buyget @@ -33,4 +34,4 @@ properties: title: campaign_id description: The promotion's campaign id. campaign: - $ref: ./CampaignResponse.yaml + $ref: ./AdminCampaign.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml index 606b760d6f..010bb3dc39 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml @@ -19,6 +19,7 @@ properties: description: The updated's attribute. operator: type: string + description: The updated's operator. enum: - gt - lt diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml new file mode 100644 index 0000000000..29f54068a7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml @@ -0,0 +1,66 @@ +type: object +description: The reservation's details. +x-schemaName: AdminReservation +required: + - id + - line_item_id + - location_id + - quantity + - external_id + - description + - inventory_item_id + - inventory_item +properties: + id: + type: string + title: id + description: The reservation's ID. + line_item_id: + type: string + title: line_item_id + description: The reservation's line item id. + location_id: + type: string + title: location_id + description: The reservation's location id. + quantity: + type: string + title: quantity + description: The reservation's quantity. + external_id: + type: string + title: external_id + description: The reservation's external id. + description: + type: string + title: description + description: The reservation's description. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + inventory_item: + type: object + description: The reservation's inventory item. + metadata: + type: object + description: The reservation's metadata. + created_by: + type: string + title: created_by + description: The reservation's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The reservation's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The reservation's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The reservation's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml index 6f13a6c0e5..42075fd8ac 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml @@ -5,4 +5,4 @@ required: - reservation properties: reservation: - $ref: ./ReservationResponse.yaml + $ref: ./AdminReservation.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml index f35a98e0a3..0ef197d0f7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml @@ -9,6 +9,7 @@ required: - items - received_at - created_at + - canceled_at properties: id: type: string @@ -64,3 +65,7 @@ properties: format: date-time title: created_at description: The return's created at. + canceled_at: + type: string + title: canceled_at + description: The return's canceled at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml index 104e37834a..47cbe93e16 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml @@ -5,6 +5,7 @@ required: - id - quantity - received_quantity + - damaged_quantity - item_id - return_id properties: @@ -20,6 +21,10 @@ properties: type: number title: received_quantity description: The return item's received quantity. + damaged_quantity: + type: number + title: damaged_quantity + description: The return item's damaged quantity. reason_id: type: string title: reason_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml index 56dff1a392..d4e8756457 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The sales channel's object. + description: The name of the deleted object. default: sales-channel deleted: type: boolean title: deleted - description: The sales channel's deleted. + description: Whether the Sales Channel was deleted. parent: type: object description: The sales channel's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml index 4581ba2a6a..fb43eb3166 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The shipping option's object. + description: The name of the deleted object. default: shipping_option deleted: type: boolean title: deleted - description: The shipping option's deleted. + description: Whether the Shipping Option was deleted. parent: type: object description: The shipping option's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml index edbadf9d4d..426860c955 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The shipping profile's object. + description: The name of the deleted object. default: shipping_profile deleted: type: boolean title: deleted - description: The shipping profile's deleted. + description: Whether the Shipping Profile was deleted. parent: type: object description: The shipping profile's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml index eded6905fb..f3250de0ed 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The stock location's object. + description: The name of the deleted object. default: stock_location deleted: type: boolean title: deleted - description: The stock location's deleted. + description: Whether the Stock Location was deleted. parent: type: object description: The stock location's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml index 8d63342ef2..aa496ab053 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The tax rate's object. + description: The name of the deleted object. default: tax_rate deleted: type: boolean title: deleted - description: The tax rate's deleted. + description: Whether the Tax Rate was deleted. parent: type: object description: The tax rate's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml index fcc06bd342..4e2ac8feb4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The tax region's object. + description: The name of the deleted object. default: tax_region deleted: type: boolean title: deleted - description: The tax region's deleted. + description: Whether the Tax Region was deleted. parent: type: object description: The tax region's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml index f6929dd104..464f157c82 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml @@ -24,11 +24,13 @@ properties: description: The price list's ends at. status: type: string + description: The price list's status. enum: - active - draft type: type: string + description: The price list's type. enum: - sale - override diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml index c5e1c3c7a9..844455161e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml @@ -45,6 +45,7 @@ properties: description: The update's handle. status: type: string + description: The update's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml index 5714e8f25d..eb3c002ae6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml @@ -13,12 +13,12 @@ properties: object: type: string title: object - description: The user's object. + description: The name of the deleted object. default: user deleted: type: boolean title: deleted - description: The user's deleted. + description: Whether the User was deleted. parent: type: object description: The user's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml index 8e71182f9e..1c803655b9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml @@ -10,7 +10,6 @@ required: - state - created_at - updated_at - - deleted_at properties: id: type: string @@ -25,26 +24,32 @@ properties: title: transaction_id description: The workflow execution's transaction id. execution: - type: string - title: execution - description: The workflow execution's execution. + $ref: ./AdminWorkflowExecutionExecution.yaml context: + $ref: ./WorkflowExecutionContext.yaml + state: type: string - title: context - description: The workflow execution's context. - state: {} + description: The workflow execution's state. + enum: + - not_started + - invoking + - waiting_to_compensate + - compensating + - done + - reverted + - failed created_at: type: string + format: date-time title: created_at description: The workflow execution's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The workflow execution's updated at. - format: date-time deleted_at: type: string + format: date-time title: deleted_at description: The workflow execution's deleted at. - format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml new file mode 100644 index 0000000000..e589756af2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml @@ -0,0 +1,9 @@ +type: object +description: The workflow execution's execution. +x-schemaName: AdminWorkflowExecutionExecution +required: + - steps +properties: + steps: + type: object + description: The execution's steps. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml index b45304e208..4e1e727e4a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml @@ -10,17 +10,20 @@ properties: description: The application method's ID. type: type: string + description: The application method's type. enum: - fixed - percentage target_type: type: string + description: The application method's target type. enum: - items - shipping_methods - order allocation: type: string + description: The application method's allocation. enum: - each - across diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml index c1a1fc38f4..01d9216030 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml @@ -159,19 +159,19 @@ properties: description: The item's metadata. created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time deleted_at: type: string + format: date-time title: deleted_at description: The item's deleted at. - format: date-time original_total: oneOf: - type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml index bff97378cc..27c9efe996 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml @@ -32,6 +32,7 @@ properties: description: The claim item's quantity. reason: type: string + description: The claim item's reason. enum: - missing_item - wrong_item diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml index ee7a005d9c..dc086f2f8e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml @@ -119,6 +119,7 @@ properties: description: The order change's version. change_type: type: string + description: The order change's change type. enum: - return - exchange diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml index 3e6cbb2a1a..513f2f9f6a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml @@ -59,11 +59,11 @@ properties: description: The fulfillment's metadata. created_at: type: string + format: date-time title: created_at description: The fulfillment's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The fulfillment's updated at. - format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml index e3808ee206..ecf54b1785 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml @@ -146,14 +146,14 @@ properties: $ref: ./BaseOrderItemDetail.yaml created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml index f60bcd7273..309583af20 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml @@ -93,6 +93,7 @@ properties: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml index bb621de314..c07bd8c599 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml @@ -55,6 +55,7 @@ properties: description: The product's is giftcard. status: type: string + description: The product's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml index 29325b0a3b..26a4b19afb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRule.yaml @@ -19,6 +19,7 @@ properties: description: The rule's attribute. operator: type: string + description: The rule's operator. enum: - gt - lt diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml index a414e29765..e4b9f03dab 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml @@ -37,6 +37,7 @@ properties: description: The order change's version. change_type: type: string + description: The order change's change type. enum: - return - exchange diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml index ed4f9667c0..b51f369920 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml @@ -212,14 +212,14 @@ properties: $ref: ./OrderItem.yaml created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -659,6 +659,7 @@ properties: x-schemaName: OrderChangeAction status: type: string + description: The order preview's status. enum: - canceled - requires_action diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml new file mode 100644 index 0000000000..af376781b2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml @@ -0,0 +1,77 @@ +type: object +description: The cart's billing address. +x-schemaName: StoreCartAddress +required: + - id + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + oneOf: + - type: string + title: created_at + description: The billing address's created at. + - type: string + title: created_at + description: The billing address's created at. + format: date-time + updated_at: + oneOf: + - type: string + title: updated_at + description: The billing address's updated at. + - type: string + title: updated_at + description: The billing address's updated at. + format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml new file mode 100644 index 0000000000..1b92e40ec6 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml @@ -0,0 +1,306 @@ +type: object +description: The item's items. +x-schemaName: StoreCartLineItem +required: + - id + - title + - quantity + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - cart + - cart_id + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total +properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + quantity: + oneOf: + - type: string + title: quantity + description: The item's quantity. + - type: number + title: quantity + description: The item's quantity. + - type: string + title: quantity + description: The item's quantity. + - $ref: ./IBigNumber.yaml + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant: + $ref: ./BaseProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The item's variant id. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + oneOf: + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - type: number + title: compare_at_unit_price + description: The item's compare at unit price. + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - $ref: ./IBigNumber.yaml + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: string + title: unit_price + description: The item's unit price. + - $ref: ./IBigNumber.yaml + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: ./BaseLineItemTaxLine.yaml + adjustments: + type: array + description: The item's adjustments. + items: + $ref: ./BaseLineItemAdjustment.yaml + cart: + $ref: ./BaseCart.yaml + cart_id: + type: string + title: cart_id + description: The item's cart id. + metadata: + type: object + description: The item's metadata. + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The item's deleted at. + format: date-time + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: ./IBigNumber.yaml + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: ./IBigNumber.yaml + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: ./IBigNumber.yaml + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: ./IBigNumber.yaml + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: ./IBigNumber.yaml + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: ./IBigNumber.yaml + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: ./IBigNumber.yaml + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: ./IBigNumber.yaml + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: ./IBigNumber.yaml + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: ./IBigNumber.yaml + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: ./IBigNumber.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml index 38c9d30978..da0096fa7a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -94,6 +94,7 @@ properties: $ref: ./BasePaymentCollection.yaml payment_status: type: string + description: The order's payment status. enum: - canceled - not_paid @@ -112,6 +113,7 @@ properties: $ref: ./BaseOrderFulfillment.yaml fulfillment_status: type: string + description: The order's fulfillment status. enum: - canceled - not_fulfilled diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml index d19be961a8..94658ceb27 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml @@ -93,6 +93,7 @@ properties: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml index 8f607cc98a..42d6393938 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -42,6 +42,7 @@ properties: description: The product's title. status: type: string + description: The product's status. enum: - draft - proposed diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml index 6614848161..d164aa2e9c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml @@ -60,6 +60,9 @@ properties: description: The category's category children. items: $ref: ./BaseProductCategory.yaml + metadata: + type: object + description: The category's metadata. created_at: type: string format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml index a707c05720..4f35c16688 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml @@ -9,6 +9,7 @@ required: - items - received_at - created_at + - canceled_at properties: id: type: string @@ -64,3 +65,7 @@ properties: format: date-time title: created_at description: The return's created at. + canceled_at: + type: string + title: canceled_at + description: The return's canceled at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml index 4d8cc26173..13a1160363 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml @@ -26,6 +26,7 @@ properties: description: The shipping option's name. price_type: type: string + description: The shipping option's price type. enum: - flat - calculated diff --git a/www/apps/api-reference/specs/store/components/schemas/WorkflowExecutionContext.yaml b/www/apps/api-reference/specs/store/components/schemas/WorkflowExecutionContext.yaml new file mode 100644 index 0000000000..2d20174121 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/WorkflowExecutionContext.yaml @@ -0,0 +1,19 @@ +type: object +description: The workflow execution's context. +x-schemaName: WorkflowExecutionContext +required: + - compensate + - errors +properties: + data: + type: object + description: The context's data. + compensate: + type: object + description: The context's compensate. + errors: + type: array + description: The context's errors. + items: + type: object + description: The error's errors. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 8cfaee159b..7c8f198170 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -9,12 +9,6 @@ servers: - url: http://localhost:9000 - url: https://api.medusajs.com tags: - - name: Auth - description: | - Auth API routes allow you to manage a customer's authentication. - externalDocs: - description: How to register a customer in a storefront. - url: https://docs.medusajs.com/v2/resources/storefront-development/customers/register - name: Carts description: | A cart is a virtual shopping bag that customers can use to add items they want to purchase. @@ -601,6 +595,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCartWorkflow /store/carts/{id}/complete: post: operationId: PostCartsIdComplete @@ -826,6 +821,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: addToCartWorkflow /store/carts/{id}/line-items/{line_id}: post: operationId: PostCartsIdLineItemsLine_id @@ -921,6 +917,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateLineItemInCartWorkflow delete: operationId: DeleteCartsIdLineItemsLine_id summary: Remove Line Items from Cart @@ -1025,6 +1022,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteLineItemsWorkflow /store/carts/{id}/promotions: post: operationId: PostCartsIdPromotions @@ -1126,6 +1124,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCartPromotionsWorkflow delete: operationId: DeleteCartsIdPromotions summary: Remove Promotions from Cart @@ -1209,6 +1208,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCartPromotionsWorkflow /store/carts/{id}/shipping-methods: post: operationId: PostCartsIdShippingMethods @@ -1308,6 +1308,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: addShippingMethodToWorkflow /store/carts/{id}/taxes: post: operationId: PostCartsIdTaxes @@ -1391,6 +1392,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateTaxLinesWorkflow /store/collections: get: operationId: GetCollections @@ -1806,6 +1808,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createCustomerAccountWorkflow /store/customers/me: get: operationId: GetCustomersMe @@ -1971,6 +1974,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCustomersWorkflow /store/customers/me/addresses: get: operationId: GetCustomersMeAddresses @@ -2325,6 +2329,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createCustomerAddressesWorkflow /store/customers/me/addresses/{address_id}: get: operationId: GetCustomersMeAddressesAddress_id @@ -2580,6 +2585,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: updateCustomerAddressesWorkflow delete: operationId: DeleteCustomersMeAddressesAddress_id summary: Remove Addresses from Customer @@ -2683,6 +2689,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: deleteCustomerAddressesWorkflow /store/orders: get: operationId: GetOrders @@ -3047,6 +3054,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createPaymentCollectionForCartWorkflow /store/payment-collections/{id}/payment-sessions: post: operationId: PostPaymentCollectionsIdPaymentSessions @@ -3149,6 +3157,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createPaymentSessionsWorkflow /store/payment-providers: get: operationId: GetPaymentProviders @@ -3412,7 +3421,7 @@ paths: - name: include_ancestors_tree in: query description: The product category's include ancestors tree. - required: true + required: false schema: type: boolean title: include_ancestors_tree @@ -3420,7 +3429,7 @@ paths: - name: include_descendants_tree in: query description: The product category's include descendants tree. - required: true + required: false schema: type: boolean title: include_descendants_tree @@ -3429,104 +3438,17 @@ paths: in: query description: The product category's created at. required: false - schema: - type: string - description: The product category's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The product category's updated at. required: false - schema: - type: string - description: The product category's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The product category's deleted at. required: false - schema: - type: string - description: The product category's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false @@ -3626,7 +3548,7 @@ paths: - name: include_ancestors_tree in: query description: The product category's include ancestors tree. - required: true + required: false schema: type: boolean title: include_ancestors_tree @@ -3634,7 +3556,7 @@ paths: - name: include_descendants_tree in: query description: The product category's include descendants tree. - required: true + required: false schema: type: boolean title: include_descendants_tree @@ -3718,11 +3640,9 @@ paths: type: array description: The product's $and. items: - type: array + type: object description: The $and's details. - items: - type: object - title: $and + title: $and - name: $or in: query required: false @@ -3730,11 +3650,9 @@ paths: type: array description: The product's $or. items: - type: array + type: object description: The $or's details. - items: - type: object - title: $or + title: $or - name: variants in: query description: The product's variants. @@ -3865,1899 +3783,175 @@ paths: type: array description: The created at's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. + type: object $or: type: array description: The created at's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. + type: object $eq: oneOf: - type: string title: $eq - description: The created at's $eq. - - type: object - description: The created at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + description: Filter by an exact match. - type: array - description: The created at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The created at's $ne. - - type: object - description: The created at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1165: - type: object - description: The $ne's @match@1165. - __@replace@1167: - type: object - description: The $ne's @replace@1167. - __@search@1170: - type: object - description: The $ne's @search@1170. - __@split@1172: - type: object - description: The $ne's @split@1172. - __@matchAll@1174: - type: object - description: The $ne's @matchall@1174. + type: string + title: $ne $in: type: array description: The created at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1165: - type: object - description: The $in's @match@1165. - __@replace@1167: - type: object - description: The $in's @replace@1167. - __@search@1170: - type: object - description: The $in's @search@1170. - __@split@1172: - type: object - description: The $in's @split@1172. - __@matchAll@1174: - type: object - description: The $in's @matchall@1174. + type: string + title: $in $nin: type: array description: The created at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1165: - type: object - description: The $nin's @match@1165. - __@replace@1167: - type: object - description: The $nin's @replace@1167. - __@search@1170: - type: object - description: The $nin's @search@1170. - __@split@1172: - type: object - description: The $nin's @split@1172. - __@matchAll@1174: - type: object - description: The $nin's @matchall@1174. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The created at's $not. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The created at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. - - type: object - description: The created at's $not. + description: Filter by values not matching the conditions in this parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: array - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap - description: The $overlap's details. + description: Filter arrays that have overlapping values with this parameter. $contains: type: array - description: The $not's $contains. + description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: The $contain's $contains. + description: Filter arrays that contain some of the values of this parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: The created at's $not. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The created at's $gt. - - type: object - description: The created at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1165: - type: object - description: The $gt's @match@1165. - __@replace@1167: - type: object - description: The $gt's @replace@1167. - __@search@1170: - type: object - description: The $gt's @search@1170. - __@split@1172: - type: object - description: The $gt's @split@1172. - __@matchAll@1174: - type: object - description: The $gt's @matchall@1174. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The created at's $gte. - - type: object - description: The created at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1165: - type: object - description: The $gte's @match@1165. - __@replace@1167: - type: object - description: The $gte's @replace@1167. - __@search@1170: - type: object - description: The $gte's @search@1170. - __@split@1172: - type: object - description: The $gte's @split@1172. - __@matchAll@1174: - type: object - description: The $gte's @matchall@1174. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The created at's $lt. - - type: object - description: The created at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1165: - type: object - description: The $lt's @match@1165. - __@replace@1167: - type: object - description: The $lt's @replace@1167. - __@search@1170: - type: object - description: The $lt's @search@1170. - __@split@1172: - type: object - description: The $lt's @split@1172. - __@matchAll@1174: - type: object - description: The $lt's @matchall@1174. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The created at's $lte. - - type: object - description: The created at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1165: - type: object - description: The $lte's @match@1165. - __@replace@1167: - type: object - description: The $lte's @replace@1167. - __@search@1170: - type: object - description: The $lte's @search@1170. - __@split@1172: - type: object - description: The $lte's @split@1172. - __@matchAll@1174: - type: object - description: The $lte's @matchall@1174. + type: string + title: $lte $like: type: string title: $like @@ -5811,1899 +4005,175 @@ paths: type: array description: The updated at's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. + type: object $or: type: array description: The updated at's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. + type: object $eq: oneOf: - type: string title: $eq - description: The updated at's $eq. - - type: object - description: The updated at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + description: Filter by an exact match. - type: array - description: The updated at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The updated at's $ne. - - type: object - description: The updated at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1165: - type: object - description: The $ne's @match@1165. - __@replace@1167: - type: object - description: The $ne's @replace@1167. - __@search@1170: - type: object - description: The $ne's @search@1170. - __@split@1172: - type: object - description: The $ne's @split@1172. - __@matchAll@1174: - type: object - description: The $ne's @matchall@1174. + type: string + title: $ne $in: type: array description: The updated at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1165: - type: object - description: The $in's @match@1165. - __@replace@1167: - type: object - description: The $in's @replace@1167. - __@search@1170: - type: object - description: The $in's @search@1170. - __@split@1172: - type: object - description: The $in's @split@1172. - __@matchAll@1174: - type: object - description: The $in's @matchall@1174. + type: string + title: $in $nin: type: array description: The updated at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1165: - type: object - description: The $nin's @match@1165. - __@replace@1167: - type: object - description: The $nin's @replace@1167. - __@search@1170: - type: object - description: The $nin's @search@1170. - __@split@1172: - type: object - description: The $nin's @split@1172. - __@matchAll@1174: - type: object - description: The $nin's @matchall@1174. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The updated at's $not. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The updated at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. - - type: object - description: The updated at's $not. + description: Filter by values not matching the conditions in this parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: array - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap - description: The $overlap's details. + description: Filter arrays that have overlapping values with this parameter. $contains: type: array - description: The $not's $contains. + description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: The $contain's $contains. + description: Filter arrays that contain some of the values of this parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: The updated at's $not. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The updated at's $gt. - - type: object - description: The updated at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1165: - type: object - description: The $gt's @match@1165. - __@replace@1167: - type: object - description: The $gt's @replace@1167. - __@search@1170: - type: object - description: The $gt's @search@1170. - __@split@1172: - type: object - description: The $gt's @split@1172. - __@matchAll@1174: - type: object - description: The $gt's @matchall@1174. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The updated at's $gte. - - type: object - description: The updated at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1165: - type: object - description: The $gte's @match@1165. - __@replace@1167: - type: object - description: The $gte's @replace@1167. - __@search@1170: - type: object - description: The $gte's @search@1170. - __@split@1172: - type: object - description: The $gte's @split@1172. - __@matchAll@1174: - type: object - description: The $gte's @matchall@1174. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The updated at's $lt. - - type: object - description: The updated at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1165: - type: object - description: The $lt's @match@1165. - __@replace@1167: - type: object - description: The $lt's @replace@1167. - __@search@1170: - type: object - description: The $lt's @search@1170. - __@split@1172: - type: object - description: The $lt's @split@1172. - __@matchAll@1174: - type: object - description: The $lt's @matchall@1174. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The updated at's $lte. - - type: object - description: The updated at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1165: - type: object - description: The $lte's @match@1165. - __@replace@1167: - type: object - description: The $lte's @replace@1167. - __@search@1170: - type: object - description: The $lte's @search@1170. - __@split@1172: - type: object - description: The $lte's @split@1172. - __@matchAll@1174: - type: object - description: The $lte's @matchall@1174. + type: string + title: $lte $like: type: string title: $like @@ -7757,1899 +4227,175 @@ paths: type: array description: The deleted at's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. + type: object $or: type: array description: The deleted at's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. + type: object $eq: oneOf: - type: string title: $eq - description: The deleted at's $eq. - - type: object - description: The deleted at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + description: Filter by an exact match. - type: array - description: The deleted at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The deleted at's $ne. - - type: object - description: The deleted at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1165: - type: object - description: The $ne's @match@1165. - __@replace@1167: - type: object - description: The $ne's @replace@1167. - __@search@1170: - type: object - description: The $ne's @search@1170. - __@split@1172: - type: object - description: The $ne's @split@1172. - __@matchAll@1174: - type: object - description: The $ne's @matchall@1174. + type: string + title: $ne $in: type: array description: The deleted at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1165: - type: object - description: The $in's @match@1165. - __@replace@1167: - type: object - description: The $in's @replace@1167. - __@search@1170: - type: object - description: The $in's @search@1170. - __@split@1172: - type: object - description: The $in's @split@1172. - __@matchAll@1174: - type: object - description: The $in's @matchall@1174. + type: string + title: $in $nin: type: array description: The deleted at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1165: - type: object - description: The $nin's @match@1165. - __@replace@1167: - type: object - description: The $nin's @replace@1167. - __@search@1170: - type: object - description: The $nin's @search@1170. - __@split@1172: - type: object - description: The $nin's @split@1172. - __@matchAll@1174: - type: object - description: The $nin's @matchall@1174. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The deleted at's $not. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The deleted at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. - - type: object - description: The deleted at's $not. + description: Filter by values not matching the conditions in this parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. - type: array - description: The $not's details. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: Apply a case-insensitive `like` filter. Useful for strings only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: Filter arrays that have overlapping values with this parameter. items: type: string title: $overlap - description: The $overlap's details. + description: Filter arrays that have overlapping values with this parameter. $contains: type: array - description: The $not's $contains. + description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: The $contain's $contains. + description: Filter arrays that contain some of the values of this parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: The deleted at's $not. + description: Filter by values not matching the conditions in this parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. $gt: - oneOf: - - type: string - title: $gt - description: The deleted at's $gt. - - type: object - description: The deleted at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1165: - type: object - description: The $gt's @match@1165. - __@replace@1167: - type: object - description: The $gt's @replace@1167. - __@search@1170: - type: object - description: The $gt's @search@1170. - __@split@1172: - type: object - description: The $gt's @split@1172. - __@matchAll@1174: - type: object - description: The $gt's @matchall@1174. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The deleted at's $gte. - - type: object - description: The deleted at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1165: - type: object - description: The $gte's @match@1165. - __@replace@1167: - type: object - description: The $gte's @replace@1167. - __@search@1170: - type: object - description: The $gte's @search@1170. - __@split@1172: - type: object - description: The $gte's @split@1172. - __@matchAll@1174: - type: object - description: The $gte's @matchall@1174. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The deleted at's $lt. - - type: object - description: The deleted at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1165: - type: object - description: The $lt's @match@1165. - __@replace@1167: - type: object - description: The $lt's @replace@1167. - __@search@1170: - type: object - description: The $lt's @search@1170. - __@split@1172: - type: object - description: The $lt's @split@1172. - __@matchAll@1174: - type: object - description: The $lt's @matchall@1174. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The deleted at's $lte. - - type: object - description: The deleted at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1165: - type: object - description: The $lte's @match@1165. - __@replace@1167: - type: object - description: The $lte's @replace@1167. - __@search@1170: - type: object - description: The $lte's @search@1170. - __@split@1172: - type: object - description: The $lte's @split@1172. - __@matchAll@1174: - type: object - description: The $lte's @matchall@1174. + type: string + title: $lte $like: type: string title: $like @@ -10437,47 +5183,7 @@ paths: summary: Create Return description: Create a return. x-authenticated: false - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] requestBody: content: application/json: @@ -10527,6 +5233,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + x-workflow: createAndCompleteReturnOrderWorkflow /store/return-reasons: get: operationId: GetReturnReasons @@ -10781,6 +5488,67 @@ paths: x-workflow: listShippingOptionsForCartWorkflow components: schemas: + AdminApiKey: + type: object + description: The api key's details. + x-schemaName: AdminApiKey + required: + - id + - token + - redacted + - title + - type + - last_used_at + - created_by + - created_at + - revoked_by + - revoked_at + properties: + id: + type: string + title: id + description: The api key's ID. + token: + type: string + title: token + description: The api key's token. + redacted: + type: string + title: redacted + description: The api key's redacted. + title: + type: string + title: title + description: The api key's title. + type: + type: string + description: The api key's type. + enum: + - secret + - publishable + last_used_at: + type: string + title: last_used_at + description: The api key's last used at. + format: date-time + created_by: + type: string + title: created_by + description: The api key's created by. + created_at: + type: string + format: date-time + title: created_at + description: The api key's created at. + revoked_by: + type: string + title: revoked_by + description: The api key's revoked by. + revoked_at: + type: string + title: revoked_at + description: The api key's revoked at. + format: date-time AdminApiKeyResponse: type: object description: SUMMARY @@ -10789,7 +5557,7 @@ components: - api_key properties: api_key: - $ref: '#/components/schemas/ApiKeyResponse' + $ref: '#/components/schemas/AdminApiKey' AdminArchiveOrder: type: object description: SUMMARY @@ -10844,7 +5612,7 @@ components: $ref: '#/components/schemas/AdminProduct' deleted: type: object - description: The product's deleted. + description: SUMMARY required: - ids - object @@ -10860,11 +5628,11 @@ components: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY AdminBatchProductVariantRequest: type: object description: SUMMARY @@ -10908,7 +5676,7 @@ components: $ref: '#/components/schemas/AdminProductVariant' deleted: type: object - description: The product's deleted. + description: SUMMARY required: - ids - object @@ -10924,11 +5692,85 @@ components: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY + AdminCampaign: + type: object + description: The campaign's details. + x-schemaName: AdminCampaign + required: + - id + - name + - description + - currency + - campaign_identifier + - starts_at + - ends_at + - budget + properties: + id: + type: string + title: id + description: The campaign's ID. + name: + type: string + title: name + description: The campaign's name. + description: + type: string + title: description + description: The campaign's description. + currency: + type: string + title: currency + description: The campaign's currency. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + budget: + type: object + description: The campaign's budget. + required: + - id + - type + - currency_code + - limit + - used + properties: + id: + type: string + title: id + description: The budget's ID. + type: + type: string + description: The budget's type. + enum: + - spend + - usage + currency_code: + type: string + title: currency_code + description: The budget's currency code. + limit: + type: number + title: limit + description: The budget's limit. + used: + type: number + title: used + description: The budget's used. AdminCampaignResponse: type: object description: SUMMARY @@ -10937,7 +5779,7 @@ components: - campaign properties: campaign: - $ref: '#/components/schemas/CampaignResponse' + $ref: '#/components/schemas/AdminCampaign' AdminCancelFulfillment: type: object description: SUMMARY @@ -11058,6 +5900,7 @@ components: $ref: '#/components/schemas/BasePaymentCollection' payment_status: type: string + description: The claim's payment status. enum: - canceled - not_paid @@ -11076,6 +5919,7 @@ components: $ref: '#/components/schemas/BaseOrderFulfillment' fulfillment_status: type: string + description: The claim's fulfillment status. enum: - canceled - not_fulfilled @@ -11209,12 +6053,12 @@ components: object: type: string title: object - description: The claim's object. + description: The name of the deleted object. default: claim deleted: type: boolean title: deleted - description: The claim's deleted. + description: Whether the Claim was deleted. parent: type: object description: The claim's parent. @@ -11369,12 +6213,12 @@ components: object: type: string title: object - description: The collection's object. + description: The name of the deleted object. default: collection deleted: type: boolean title: deleted - description: The collection's deleted. + description: Whether the Collection was deleted. parent: type: object description: The collection's parent. @@ -11428,6 +6272,7 @@ components: description: The api key's title. type: type: string + description: The api key's type. enum: - publishable - secret @@ -11678,11 +6523,13 @@ components: description: The price list's ends at. status: type: string + description: The price list's status. enum: - active - draft type: type: string + description: The price list's type. enum: - sale - override @@ -11792,6 +6639,7 @@ components: description: The create's handle. status: type: string + description: The create's status. enum: - draft - proposed @@ -12294,6 +7142,7 @@ components: compensate_input: {} action: type: string + description: The workflows execution's action. enum: - invoke - compensate @@ -12719,6 +7568,7 @@ components: $ref: '#/components/schemas/BasePaymentCollection' payment_status: type: string + description: The exchange's payment status. enum: - canceled - not_paid @@ -12737,6 +7587,7 @@ components: $ref: '#/components/schemas/BaseOrderFulfillment' fulfillment_status: type: string + description: The exchange's fulfillment status. enum: - canceled - not_fulfilled @@ -13361,12 +8212,12 @@ components: object: type: string title: object - description: The fulfillment set's object. + description: The name of the deleted object. default: fulfillment_set deleted: type: boolean title: deleted - description: The fulfillment set's deleted. + description: Whether the Fulfillment Set was deleted. parent: type: object description: The fulfillment set's parent. @@ -13541,14 +8392,14 @@ components: description: The invite's metadata. created_at: type: string + format: date-time title: created_at description: The invite's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The invite's updated at. - format: date-time AdminInviteResponse: type: object description: SUMMARY @@ -13761,6 +8612,7 @@ components: $ref: '#/components/schemas/BaseOrderShippingMethod' payment_status: type: string + description: The order's payment status. enum: - canceled - not_paid @@ -13774,6 +8626,7 @@ components: - requires_action fulfillment_status: type: string + description: The order's fulfillment status. enum: - canceled - not_fulfilled @@ -13891,6 +8744,18 @@ components: type: number title: original_shipping_tax_total description: The order's original shipping tax total. + AdminOrderChangesResponse: + type: object + description: SUMMARY + x-schemaName: AdminOrderChangesResponse + required: + - order_changes + properties: + order_changes: + type: array + description: The order's order changes. + items: + $ref: '#/components/schemas/BaseOrderChange' AdminOrderEditPreviewResponse: type: object description: SUMMARY @@ -14112,14 +8977,14 @@ components: $ref: '#/components/schemas/BaseOrderItemDetail' created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -14417,6 +9282,7 @@ components: $ref: '#/components/schemas/AdminPaymentCollection' payment_status: type: string + description: The order preview's payment status. enum: - canceled - not_paid @@ -14435,6 +9301,7 @@ components: $ref: '#/components/schemas/BaseOrderFulfillment' fulfillment_status: type: string + description: The order preview's fulfillment status. enum: - canceled - not_fulfilled @@ -14809,6 +9676,7 @@ components: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid @@ -14904,6 +9772,7 @@ components: description: The item's quantity. reason: type: string + description: The item's reason. enum: - missing_item - wrong_item @@ -15175,6 +10044,7 @@ components: properties: type: type: string + description: The claim's type. enum: - refund - replace @@ -15690,11 +10560,13 @@ components: description: The price list's ends at. status: type: string + description: The price list's status. enum: - draft - active type: type: string + description: The price list's type. enum: - sale - override @@ -15739,7 +10611,7 @@ components: $ref: '#/components/schemas/AdminPrice' deleted: type: object - description: The price list's deleted. + description: SUMMARY required: - ids - object @@ -15755,11 +10627,11 @@ components: object: type: string title: object - description: The deleted's object. + description: SUMMARY deleted: type: boolean title: deleted - description: The deleted's details. + description: SUMMARY AdminPriceListDeleteResponse: type: object description: SUMMARY @@ -15776,12 +10648,12 @@ components: object: type: string title: object - description: The price list's object. + description: The name of the deleted object. default: price_list deleted: type: boolean title: deleted - description: The price list's deleted. + description: Whether the Price List was deleted. parent: type: object description: The price list's parent. @@ -15953,12 +10825,12 @@ components: object: type: string title: object - description: The price preference's object. + description: The name of the deleted object. default: price_preference deleted: type: boolean title: deleted - description: The price preference's deleted. + description: Whether the Price Preference was deleted. parent: type: object description: The price preference's parent. @@ -16048,7 +10920,7 @@ components: items: $ref: '#/components/schemas/AdminProductVariant' type: - type: object + $ref: '#/components/schemas/AdminProductType' tags: type: array description: The parent's tags. @@ -16060,6 +10932,7 @@ components: description: The parent's title. status: type: string + description: The parent's status. enum: - draft - proposed @@ -16208,6 +11081,9 @@ components: type: string title: id description: The category's ID. + metadata: + type: object + description: The category's metadata. created_at: type: string format: date-time @@ -16259,12 +11135,12 @@ components: object: type: string title: object - description: The product category's object. + description: The name of the deleted object. default: product_category deleted: type: boolean title: deleted - description: The product category's deleted. + description: Whether the Product Category was deleted. parent: type: object description: The product category's parent. @@ -16320,12 +11196,12 @@ components: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: product deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: type: object description: The product's parent. @@ -16390,12 +11266,12 @@ components: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: product_option deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: '#/components/schemas/AdminProduct' AdminProductOptionResponse: @@ -16468,12 +11344,12 @@ components: object: type: string title: object - description: The product tag's object. + description: The name of the deleted object. default: product_tag deleted: type: boolean title: deleted - description: The product tag's deleted. + description: Whether the Product Tag was deleted. parent: type: object description: The product tag's parent. @@ -16513,6 +11389,42 @@ components: properties: product_tag: $ref: '#/components/schemas/AdminProductTag' + AdminProductType: + type: object + description: The parent's type. + x-schemaName: AdminProductType + required: + - id + - value + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The type's ID. + value: + type: string + title: value + description: The type's value. + created_at: + type: string + format: date-time + title: created_at + description: The type's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The type's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The type's deleted at. + metadata: + type: object + description: The type's metadata. AdminProductTypeDeleteResponse: type: object description: SUMMARY @@ -16529,12 +11441,12 @@ components: object: type: string title: object - description: The product type's object. + description: The name of the deleted object. default: product_type deleted: type: boolean title: deleted - description: The product type's deleted. + description: Whether the Product Type was deleted. parent: type: object description: The product type's parent. @@ -16564,7 +11476,7 @@ components: type: array description: The product type's product types. items: - $ref: '#/components/schemas/AdminProduct' + $ref: '#/components/schemas/AdminProductType' AdminProductTypeResponse: type: object description: SUMMARY @@ -16573,7 +11485,7 @@ components: - product_type properties: product_type: - $ref: '#/components/schemas/AdminProduct' + $ref: '#/components/schemas/AdminProductType' AdminProductVariant: type: object description: The product's parent. @@ -16721,12 +11633,12 @@ components: object: type: string title: object - description: The product's object. + description: The name of the deleted object. default: variant deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: '#/components/schemas/AdminProduct' AdminProductVariantInventoryBatchResponse: @@ -16808,10 +11720,10 @@ components: oneOf: - $ref: '#/components/schemas/AdminProductVariantInventoryLink' - type: array - description: The product's deleted. + description: SUMMARY items: type: object - description: The deleted's details. + description: SUMMARY x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -16880,11 +11792,11 @@ components: object: type: string title: object - description: The product's object. + description: The name of the deleted object. deleted: type: boolean title: deleted - description: The product's deleted. + description: Whether the Product was deleted. parent: $ref: '#/components/schemas/AdminProductVariant' AdminProductVariantParams: @@ -16952,20 +11864,14 @@ components: type: array description: The variant's $and. items: - type: array - description: The $and's details. - items: - type: object - title: $and + type: object + title: $and $or: type: array description: The variant's $or. items: - type: array - description: The $or's details. - items: - type: object - title: $or + type: object + title: $or AdminProductVariantResponse: type: object description: SUMMARY @@ -16992,6 +11898,7 @@ components: description: The promotion's code. type: type: string + description: The promotion's type. enum: - standard - buyget @@ -17011,7 +11918,7 @@ components: title: campaign_id description: The promotion's campaign id. campaign: - $ref: '#/components/schemas/CampaignResponse' + $ref: '#/components/schemas/AdminCampaign' AdminPromotionResponse: type: object description: SUMMARY @@ -17043,6 +11950,7 @@ components: description: The updated's attribute. operator: type: string + description: The updated's operator. enum: - gt - lt @@ -17149,6 +12057,73 @@ components: properties: region: $ref: '#/components/schemas/AdminRegion' + AdminReservation: + type: object + description: The reservation's details. + x-schemaName: AdminReservation + required: + - id + - line_item_id + - location_id + - quantity + - external_id + - description + - inventory_item_id + - inventory_item + properties: + id: + type: string + title: id + description: The reservation's ID. + line_item_id: + type: string + title: line_item_id + description: The reservation's line item id. + location_id: + type: string + title: location_id + description: The reservation's location id. + quantity: + type: string + title: quantity + description: The reservation's quantity. + external_id: + type: string + title: external_id + description: The reservation's external id. + description: + type: string + title: description + description: The reservation's description. + inventory_item_id: + type: string + title: inventory_item_id + description: The reservation's inventory item id. + inventory_item: + type: object + description: The reservation's inventory item. + metadata: + type: object + description: The reservation's metadata. + created_by: + type: string + title: created_by + description: The reservation's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The reservation's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The reservation's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The reservation's updated at. AdminReservationResponse: type: object description: SUMMARY @@ -17157,7 +12132,7 @@ components: - reservation properties: reservation: - $ref: '#/components/schemas/ReservationResponse' + $ref: '#/components/schemas/AdminReservation' AdminReturn: type: object description: The exchange's return. @@ -17170,6 +12145,7 @@ components: - items - received_at - created_at + - canceled_at properties: id: type: string @@ -17225,6 +12201,10 @@ components: format: date-time title: created_at description: The return's created at. + canceled_at: + type: string + title: canceled_at + description: The return's canceled at. AdminReturnItem: type: object description: The return item's return items. @@ -17233,6 +12213,7 @@ components: - id - quantity - received_quantity + - damaged_quantity - item_id - return_id properties: @@ -17248,6 +12229,10 @@ components: type: number title: received_quantity description: The return item's received quantity. + damaged_quantity: + type: number + title: damaged_quantity + description: The return item's damaged quantity. reason_id: type: string title: reason_id @@ -17500,12 +12485,12 @@ components: object: type: string title: object - description: The sales channel's object. + description: The name of the deleted object. default: sales-channel deleted: type: boolean title: deleted - description: The sales channel's deleted. + description: Whether the Sales Channel was deleted. parent: type: object description: The sales channel's parent. @@ -17601,12 +12586,12 @@ components: object: type: string title: object - description: The shipping option's object. + description: The name of the deleted object. default: shipping_option deleted: type: boolean title: deleted - description: The shipping option's deleted. + description: Whether the Shipping Option was deleted. parent: type: object description: The shipping option's parent. @@ -17695,12 +12680,12 @@ components: object: type: string title: object - description: The shipping profile's object. + description: The name of the deleted object. default: shipping_profile deleted: type: boolean title: deleted - description: The shipping profile's deleted. + description: Whether the Shipping Profile was deleted. parent: type: object description: The shipping profile's parent. @@ -17771,12 +12756,12 @@ components: object: type: string title: object - description: The stock location's object. + description: The name of the deleted object. default: stock_location deleted: type: boolean title: deleted - description: The stock location's deleted. + description: Whether the Stock Location was deleted. parent: type: object description: The stock location's parent. @@ -18045,12 +13030,12 @@ components: object: type: string title: object - description: The tax rate's object. + description: The name of the deleted object. default: tax_rate deleted: type: boolean title: deleted - description: The tax rate's deleted. + description: Whether the Tax Rate was deleted. parent: type: object description: The tax rate's parent. @@ -18193,12 +13178,12 @@ components: object: type: string title: object - description: The tax region's object. + description: The name of the deleted object. default: tax_region deleted: type: boolean title: deleted - description: The tax region's deleted. + description: Whether the Tax Region was deleted. parent: type: object description: The tax region's parent. @@ -18281,11 +13266,13 @@ components: description: The price list's ends at. status: type: string + description: The price list's status. enum: - active - draft type: type: string + description: The price list's type. enum: - sale - override @@ -18357,6 +13344,7 @@ components: description: The update's handle. status: type: string + description: The update's status. enum: - draft - proposed @@ -18999,12 +13987,12 @@ components: object: type: string title: object - description: The user's object. + description: The name of the deleted object. default: user deleted: type: boolean title: deleted - description: The user's deleted. + description: Whether the User was deleted. parent: type: object description: The user's parent. @@ -19057,7 +14045,6 @@ components: - state - created_at - updated_at - - deleted_at properties: id: type: string @@ -19072,29 +14059,45 @@ components: title: transaction_id description: The workflow execution's transaction id. execution: - type: string - title: execution - description: The workflow execution's execution. + $ref: '#/components/schemas/AdminWorkflowExecutionExecution' context: + $ref: '#/components/schemas/WorkflowExecutionContext' + state: type: string - title: context - description: The workflow execution's context. - state: {} + description: The workflow execution's state. + enum: + - not_started + - invoking + - waiting_to_compensate + - compensating + - done + - reverted + - failed created_at: type: string + format: date-time title: created_at description: The workflow execution's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The workflow execution's updated at. - format: date-time deleted_at: type: string + format: date-time title: deleted_at description: The workflow execution's deleted at. - format: date-time + AdminWorkflowExecutionExecution: + type: object + description: The workflow execution's execution. + x-schemaName: AdminWorkflowExecutionExecution + required: + - steps + properties: + steps: + type: object + description: The execution's steps. AdminWorkflowExecutionResponse: type: object description: SUMMARY @@ -19210,17 +14213,20 @@ components: description: The application method's ID. type: type: string + description: The application method's type. enum: - fixed - percentage target_type: type: string + description: The application method's target type. enum: - items - shipping_methods - order allocation: type: string + description: The application method's allocation. enum: - each - across @@ -19552,19 +14558,19 @@ components: description: The item's metadata. created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time deleted_at: type: string + format: date-time title: deleted_at description: The item's deleted at. - format: date-time original_total: oneOf: - type: string @@ -19915,6 +14921,7 @@ components: description: The claim item's quantity. reason: type: string + description: The claim item's reason. enum: - missing_item - wrong_item @@ -20308,6 +15315,7 @@ components: description: The order change's version. change_type: type: string + description: The order change's change type. enum: - return - exchange @@ -20398,14 +15406,14 @@ components: description: The fulfillment's metadata. created_at: type: string + format: date-time title: created_at description: The fulfillment's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The fulfillment's updated at. - format: date-time BaseOrderItemDetail: type: object description: The item's detail. @@ -20559,14 +15567,14 @@ components: $ref: '#/components/schemas/BaseOrderItemDetail' created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -21045,6 +16053,7 @@ components: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid @@ -21132,6 +16141,7 @@ components: description: The product's is giftcard. status: type: string + description: The product's status. enum: - draft - proposed @@ -21322,6 +16332,7 @@ components: description: The rule's attribute. operator: type: string + description: The rule's operator. enum: - gt - lt @@ -22040,6 +17051,7 @@ components: description: The order change's version. change_type: type: string + description: The order change's change type. enum: - return - exchange @@ -22386,14 +17398,14 @@ components: $ref: '#/components/schemas/OrderItem' created_at: type: string + format: date-time title: created_at description: The item's created at. - format: date-time updated_at: type: string + format: date-time title: updated_at description: The item's updated at. - format: date-time metadata: type: object description: The item's metadata. @@ -22833,6 +17845,7 @@ components: x-schemaName: OrderChangeAction status: type: string + description: The order preview's status. enum: - canceled - requires_action @@ -24236,6 +19249,391 @@ components: title: original_shipping_tax_total description: The cart's original shipping tax total. - $ref: '#/components/schemas/IBigNumber' + StoreCartAddress: + type: object + description: The cart's billing address. + x-schemaName: StoreCartAddress + required: + - id + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The billing address's ID. + customer_id: + type: string + title: customer_id + description: The billing address's customer id. + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + created_at: + oneOf: + - type: string + title: created_at + description: The billing address's created at. + - type: string + title: created_at + description: The billing address's created at. + format: date-time + updated_at: + oneOf: + - type: string + title: updated_at + description: The billing address's updated at. + - type: string + title: updated_at + description: The billing address's updated at. + format: date-time + StoreCartLineItem: + type: object + description: The item's items. + x-schemaName: StoreCartLineItem + required: + - id + - title + - quantity + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - cart + - cart_id + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + quantity: + oneOf: + - type: string + title: quantity + description: The item's quantity. + - type: number + title: quantity + description: The item's quantity. + - type: string + title: quantity + description: The item's quantity. + - $ref: '#/components/schemas/IBigNumber' + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant: + $ref: '#/components/schemas/BaseProductVariant' + variant_id: + type: string + title: variant_id + description: The item's variant id. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + oneOf: + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - type: number + title: compare_at_unit_price + description: The item's compare at unit price. + - type: string + title: compare_at_unit_price + description: The item's compare at unit price. + - $ref: '#/components/schemas/IBigNumber' + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: string + title: unit_price + description: The item's unit price. + - $ref: '#/components/schemas/IBigNumber' + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/BaseLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/BaseLineItemAdjustment' + cart: + $ref: '#/components/schemas/BaseCart' + cart_id: + type: string + title: cart_id + description: The item's cart id. + metadata: + type: object + description: The item's metadata. + created_at: + type: string + title: created_at + description: The item's created at. + format: date-time + updated_at: + type: string + title: updated_at + description: The item's updated at. + format: date-time + deleted_at: + type: string + title: deleted_at + description: The item's deleted at. + format: date-time + original_total: + oneOf: + - type: string + title: original_total + description: The item's original total. + - type: number + title: original_total + description: The item's original total. + - type: string + title: original_total + description: The item's original total. + - $ref: '#/components/schemas/IBigNumber' + original_subtotal: + oneOf: + - type: string + title: original_subtotal + description: The item's original subtotal. + - type: number + title: original_subtotal + description: The item's original subtotal. + - type: string + title: original_subtotal + description: The item's original subtotal. + - $ref: '#/components/schemas/IBigNumber' + original_tax_total: + oneOf: + - type: string + title: original_tax_total + description: The item's original tax total. + - type: number + title: original_tax_total + description: The item's original tax total. + - type: string + title: original_tax_total + description: The item's original tax total. + - $ref: '#/components/schemas/IBigNumber' + item_total: + oneOf: + - type: string + title: item_total + description: The item's item total. + - type: number + title: item_total + description: The item's item total. + - type: string + title: item_total + description: The item's item total. + - $ref: '#/components/schemas/IBigNumber' + item_subtotal: + oneOf: + - type: string + title: item_subtotal + description: The item's item subtotal. + - type: number + title: item_subtotal + description: The item's item subtotal. + - type: string + title: item_subtotal + description: The item's item subtotal. + - $ref: '#/components/schemas/IBigNumber' + item_tax_total: + oneOf: + - type: string + title: item_tax_total + description: The item's item tax total. + - type: number + title: item_tax_total + description: The item's item tax total. + - type: string + title: item_tax_total + description: The item's item tax total. + - $ref: '#/components/schemas/IBigNumber' + total: + oneOf: + - type: string + title: total + description: The item's total. + - type: number + title: total + description: The item's total. + - type: string + title: total + description: The item's total. + - $ref: '#/components/schemas/IBigNumber' + subtotal: + oneOf: + - type: string + title: subtotal + description: The item's subtotal. + - type: number + title: subtotal + description: The item's subtotal. + - type: string + title: subtotal + description: The item's subtotal. + - $ref: '#/components/schemas/IBigNumber' + tax_total: + oneOf: + - type: string + title: tax_total + description: The item's tax total. + - type: number + title: tax_total + description: The item's tax total. + - type: string + title: tax_total + description: The item's tax total. + - $ref: '#/components/schemas/IBigNumber' + discount_total: + oneOf: + - type: string + title: discount_total + description: The item's discount total. + - type: number + title: discount_total + description: The item's discount total. + - type: string + title: discount_total + description: The item's discount total. + - $ref: '#/components/schemas/IBigNumber' + discount_tax_total: + oneOf: + - type: string + title: discount_tax_total + description: The item's discount tax total. + - type: number + title: discount_tax_total + description: The item's discount tax total. + - type: string + title: discount_tax_total + description: The item's discount tax total. + - $ref: '#/components/schemas/IBigNumber' StoreCartResponse: type: object description: SUMMARY @@ -24753,6 +20151,7 @@ components: $ref: '#/components/schemas/BasePaymentCollection' payment_status: type: string + description: The order's payment status. enum: - canceled - not_paid @@ -24771,6 +20170,7 @@ components: $ref: '#/components/schemas/BaseOrderFulfillment' fulfillment_status: type: string + description: The order's fulfillment status. enum: - canceled - not_fulfilled @@ -24993,6 +20393,7 @@ components: description: The payment collection's metadata. status: type: string + description: The payment collection's status. enum: - canceled - not_paid @@ -25148,6 +20549,7 @@ components: description: The product's title. status: type: string + description: The product's status. enum: - draft - proposed @@ -25328,6 +20730,9 @@ components: description: The category's category children. items: $ref: '#/components/schemas/BaseProductCategory' + metadata: + type: object + description: The category's metadata. created_at: type: string format: date-time @@ -25448,6 +20853,7 @@ components: - items - received_at - created_at + - canceled_at properties: id: type: string @@ -25503,6 +20909,10 @@ components: format: date-time title: created_at description: The return's created at. + canceled_at: + type: string + title: canceled_at + description: The return's canceled at. StoreReturnReason: type: object description: The return reason's details. @@ -25590,6 +21000,7 @@ components: description: The shipping option's name. price_type: type: string + description: The shipping option's price type. enum: - flat - calculated @@ -25807,6 +21218,26 @@ components: metadata: type: object description: The return reason's metadata. + WorkflowExecutionContext: + type: object + description: The workflow execution's context. + x-schemaName: WorkflowExecutionContext + required: + - compensate + - errors + properties: + data: + type: object + description: The context's data. + compensate: + type: object + description: The context's compensate. + errors: + type: array + description: The context's errors. + items: + type: object + description: The error's errors. responses: default_error: description: Default Error diff --git a/www/apps/api-reference/specs/store/openapi.yaml b/www/apps/api-reference/specs/store/openapi.yaml index 040bc1251a..4488696451 100644 --- a/www/apps/api-reference/specs/store/openapi.yaml +++ b/www/apps/api-reference/specs/store/openapi.yaml @@ -9,13 +9,6 @@ servers: - url: http://localhost:9000 - url: https://api.medusajs.com tags: - - name: Auth - description: | - Auth API routes allow you to manage a customer's authentication. - externalDocs: - description: How to register a customer in a storefront. - url: >- - https://docs.medusajs.com/v2/resources/storefront-development/customers/register - name: Carts description: > A cart is a virtual shopping bag that customers can use to add items they diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml index d2e9d52a7c..bf9d487c3e 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml @@ -208,3 +208,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCartWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml index 52dba6938f..30046012ab 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml @@ -96,3 +96,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: addToCartWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml index 78c9104010..4f91c8e757 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml @@ -102,6 +102,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateLineItemInCartWorkflow delete: operationId: DeleteCartsIdLineItemsLine_id summary: Remove Line Items from Cart @@ -224,3 +225,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteLineItemsWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml index 2f5fbd2da4..a0ecc71497 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml @@ -107,6 +107,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCartPromotionsWorkflow delete: operationId: DeleteCartsIdPromotions summary: Remove Promotions from Cart @@ -208,3 +209,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCartPromotionsWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml index 30c8263c00..bc30300e32 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml @@ -107,3 +107,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: addShippingMethodToWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml index c0de63824f..e74c1f27f7 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml @@ -96,3 +96,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateTaxLinesWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_customers.yaml b/www/apps/api-reference/specs/store/paths/store_customers.yaml index 42727bd80a..e721bb12c2 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml @@ -90,3 +90,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createCustomerAccountWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml index 1a6ea0eeab..4c03820c70 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml @@ -185,3 +185,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCustomersWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml index 4fa2d76d9b..3e5db28f3f 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml @@ -366,3 +366,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createCustomerAddressesWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml index 0861d56f33..607a58b7d2 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml @@ -268,6 +268,7 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: updateCustomerAddressesWorkflow delete: operationId: DeleteCustomersMeAddressesAddress_id summary: Remove Addresses from Customer @@ -388,3 +389,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: deleteCustomerAddressesWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml index e154b1d255..fa79d501b7 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml @@ -98,3 +98,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createPaymentCollectionForCartWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml index b7ec4f3200..ad66307dff 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml @@ -111,3 +111,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createPaymentSessionsWorkflow diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml index b344ef0582..c9133bddc5 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml @@ -129,7 +129,7 @@ get: - name: include_ancestors_tree in: query description: The product category's include ancestors tree. - required: true + required: false schema: type: boolean title: include_ancestors_tree @@ -137,7 +137,7 @@ get: - name: include_descendants_tree in: query description: The product category's include descendants tree. - required: true + required: false schema: type: boolean title: include_descendants_tree @@ -146,104 +146,17 @@ get: in: query description: The product category's created at. required: false - schema: - type: string - description: The product category's created at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: created_at + schema: {} - name: updated_at in: query description: The product category's updated at. required: false - schema: - type: string - description: The product category's updated at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: updated_at + schema: {} - name: deleted_at in: query description: The product category's deleted at. required: false - schema: - type: string - description: The product category's deleted at. - required: - - $eq - - $ne - - $in - - $nin - - $like - - $ilike - - $re - - $contains - - $gt - - $gte - - $lt - - $lte - properties: - $eq: {} - $ne: {} - $in: {} - $nin: {} - $like: {} - $ilike: {} - $re: {} - $contains: {} - $gt: {} - $gte: {} - $lt: {} - $lte: {} - title: deleted_at + schema: {} - name: $and in: query required: false diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml index 2785c6ec53..a98362fe16 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml @@ -70,7 +70,7 @@ get: - name: include_ancestors_tree in: query description: The product category's include ancestors tree. - required: true + required: false schema: type: boolean title: include_ancestors_tree @@ -78,7 +78,7 @@ get: - name: include_descendants_tree in: query description: The product category's include descendants tree. - required: true + required: false schema: type: boolean title: include_descendants_tree diff --git a/www/apps/api-reference/specs/store/paths/store_products.yaml b/www/apps/api-reference/specs/store/paths/store_products.yaml index 32673b9f6d..c7ab02dcb2 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -68,11 +68,9 @@ get: type: array description: The product's $and. items: - type: array + type: object description: The $and's details. - items: - type: object - title: $and + title: $and - name: $or in: query required: false @@ -80,11 +78,9 @@ get: type: array description: The product's $or. items: - type: array + type: object description: The $or's details. - items: - type: object - title: $or + title: $or - name: variants in: query description: The product's variants. @@ -215,1899 +211,211 @@ get: type: array description: The created at's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. + type: object $or: type: array description: The created at's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. + type: object $eq: oneOf: - type: string title: $eq - description: The created at's $eq. - - type: object - description: The created at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + description: Filter by an exact match. - type: array - description: The created at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The created at's $ne. - - type: object - description: The created at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1165: - type: object - description: The $ne's @match@1165. - __@replace@1167: - type: object - description: The $ne's @replace@1167. - __@search@1170: - type: object - description: The $ne's @search@1170. - __@split@1172: - type: object - description: The $ne's @split@1172. - __@matchAll@1174: - type: object - description: The $ne's @matchall@1174. + type: string + title: $ne $in: type: array description: The created at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1165: - type: object - description: The $in's @match@1165. - __@replace@1167: - type: object - description: The $in's @replace@1167. - __@search@1170: - type: object - description: The $in's @search@1170. - __@split@1172: - type: object - description: The $in's @split@1172. - __@matchAll@1174: - type: object - description: The $in's @matchall@1174. + type: string + title: $in $nin: type: array description: The created at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1165: - type: object - description: The $nin's @match@1165. - __@replace@1167: - type: object - description: The $nin's @replace@1167. - __@search@1170: - type: object - description: The $nin's @search@1170. - __@split@1172: - type: object - description: The $nin's @split@1172. - __@matchAll@1174: - type: object - description: The $nin's @matchall@1174. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The created at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The created at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. - - type: object - description: The created at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: array - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: >- + Filter arrays that have overlapping values with this + parameter. items: type: string title: $overlap - description: The $overlap's details. + description: >- + Filter arrays that have overlapping values with this + parameter. $contains: type: array - description: The $not's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. items: type: string title: $contains - description: The $contain's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: >- + Filter by whether a value for this parameter exists (not + `null`). - type: array - description: The created at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The created at's $gt. - - type: object - description: The created at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1165: - type: object - description: The $gt's @match@1165. - __@replace@1167: - type: object - description: The $gt's @replace@1167. - __@search@1170: - type: object - description: The $gt's @search@1170. - __@split@1172: - type: object - description: The $gt's @split@1172. - __@matchAll@1174: - type: object - description: The $gt's @matchall@1174. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The created at's $gte. - - type: object - description: The created at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1165: - type: object - description: The $gte's @match@1165. - __@replace@1167: - type: object - description: The $gte's @replace@1167. - __@search@1170: - type: object - description: The $gte's @search@1170. - __@split@1172: - type: object - description: The $gte's @split@1172. - __@matchAll@1174: - type: object - description: The $gte's @matchall@1174. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The created at's $lt. - - type: object - description: The created at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1165: - type: object - description: The $lt's @match@1165. - __@replace@1167: - type: object - description: The $lt's @replace@1167. - __@search@1170: - type: object - description: The $lt's @search@1170. - __@split@1172: - type: object - description: The $lt's @split@1172. - __@matchAll@1174: - type: object - description: The $lt's @matchall@1174. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The created at's $lte. - - type: object - description: The created at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1165: - type: object - description: The $lte's @match@1165. - __@replace@1167: - type: object - description: The $lte's @replace@1167. - __@search@1170: - type: object - description: The $lte's @search@1170. - __@split@1172: - type: object - description: The $lte's @split@1172. - __@matchAll@1174: - type: object - description: The $lte's @matchall@1174. + type: string + title: $lte $like: type: string title: $like @@ -2161,1899 +469,211 @@ get: type: array description: The updated at's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. + type: object $or: type: array description: The updated at's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. + type: object $eq: oneOf: - type: string title: $eq - description: The updated at's $eq. - - type: object - description: The updated at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + description: Filter by an exact match. - type: array - description: The updated at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The updated at's $ne. - - type: object - description: The updated at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1165: - type: object - description: The $ne's @match@1165. - __@replace@1167: - type: object - description: The $ne's @replace@1167. - __@search@1170: - type: object - description: The $ne's @search@1170. - __@split@1172: - type: object - description: The $ne's @split@1172. - __@matchAll@1174: - type: object - description: The $ne's @matchall@1174. + type: string + title: $ne $in: type: array description: The updated at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1165: - type: object - description: The $in's @match@1165. - __@replace@1167: - type: object - description: The $in's @replace@1167. - __@search@1170: - type: object - description: The $in's @search@1170. - __@split@1172: - type: object - description: The $in's @split@1172. - __@matchAll@1174: - type: object - description: The $in's @matchall@1174. + type: string + title: $in $nin: type: array description: The updated at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1165: - type: object - description: The $nin's @match@1165. - __@replace@1167: - type: object - description: The $nin's @replace@1167. - __@search@1170: - type: object - description: The $nin's @search@1170. - __@split@1172: - type: object - description: The $nin's @split@1172. - __@matchAll@1174: - type: object - description: The $nin's @matchall@1174. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The updated at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The updated at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. - - type: object - description: The updated at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: array - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: >- + Filter arrays that have overlapping values with this + parameter. items: type: string title: $overlap - description: The $overlap's details. + description: >- + Filter arrays that have overlapping values with this + parameter. $contains: type: array - description: The $not's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. items: type: string title: $contains - description: The $contain's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: >- + Filter by whether a value for this parameter exists (not + `null`). - type: array - description: The updated at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The updated at's $gt. - - type: object - description: The updated at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1165: - type: object - description: The $gt's @match@1165. - __@replace@1167: - type: object - description: The $gt's @replace@1167. - __@search@1170: - type: object - description: The $gt's @search@1170. - __@split@1172: - type: object - description: The $gt's @split@1172. - __@matchAll@1174: - type: object - description: The $gt's @matchall@1174. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The updated at's $gte. - - type: object - description: The updated at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1165: - type: object - description: The $gte's @match@1165. - __@replace@1167: - type: object - description: The $gte's @replace@1167. - __@search@1170: - type: object - description: The $gte's @search@1170. - __@split@1172: - type: object - description: The $gte's @split@1172. - __@matchAll@1174: - type: object - description: The $gte's @matchall@1174. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The updated at's $lt. - - type: object - description: The updated at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1165: - type: object - description: The $lt's @match@1165. - __@replace@1167: - type: object - description: The $lt's @replace@1167. - __@search@1170: - type: object - description: The $lt's @search@1170. - __@split@1172: - type: object - description: The $lt's @split@1172. - __@matchAll@1174: - type: object - description: The $lt's @matchall@1174. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The updated at's $lte. - - type: object - description: The updated at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1165: - type: object - description: The $lte's @match@1165. - __@replace@1167: - type: object - description: The $lte's @replace@1167. - __@search@1170: - type: object - description: The $lte's @search@1170. - __@split@1172: - type: object - description: The $lte's @split@1172. - __@matchAll@1174: - type: object - description: The $lte's @matchall@1174. + type: string + title: $lte $like: type: string title: $like @@ -4107,1899 +727,211 @@ get: type: array description: The deleted at's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. - - type: object - description: The $and's details. - properties: - $and: - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $and's $or. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $and's $eq. - - type: object - description: The $and's $eq. - x-schemaName: RegExp - - type: array - description: The $and's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $and's $ne. - - type: object - description: The $and's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $and's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $and's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $and's $not. - - type: object - description: The $and's $not. - x-schemaName: RegExp - - type: object - description: The $and's $not. - - type: array - description: The $and's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $and's $gt. - - type: object - description: The $and's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $and's $gte. - - type: object - description: The $and's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $and's $lt. - - type: object - description: The $and's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $and's $lte. - - type: object - description: The $and's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $and's $like. - $re: - type: string - title: $re - description: The $and's $re. - $ilike: - type: string - title: $ilike - description: The $and's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $and's $fulltext. - $overlap: - type: array - description: The $and's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $and's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $and's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $and's $exists. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $and's exec. - test: - type: object - description: The $and's test. - source: - type: string - title: source - description: The $and's source. - global: - type: boolean - title: global - description: The $and's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $and's ignorecase. - multiline: - type: boolean - title: multiline - description: The $and's multiline. - lastIndex: - type: number - title: lastIndex - description: The $and's lastindex. - compile: - type: object - description: The $and's compile. - flags: - type: string - title: flags - description: The $and's flags. - sticky: - type: boolean - title: sticky - description: The $and's sticky. - unicode: - type: boolean - title: unicode - description: The $and's unicode. - dotAll: - type: boolean - title: dotAll - description: The $and's dotall. - __@match@1165: - type: object - description: The $and's @match@1165. - __@replace@1167: - type: object - description: The $and's @replace@1167. - __@search@1170: - type: object - description: The $and's @search@1170. - __@split@1172: - type: object - description: The $and's @split@1172. - __@matchAll@1174: - type: object - description: The $and's @matchall@1174. + type: object $or: type: array description: The deleted at's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. - - type: object - description: The $or's details. - properties: - $and: - type: array - description: The $or's $and. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The $or's $eq. - - type: object - description: The $or's $eq. - x-schemaName: RegExp - - type: array - description: The $or's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The $or's $ne. - - type: object - description: The $or's $ne. - x-schemaName: RegExp - $in: - type: array - description: The $or's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The $or's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The $or's $not. - - type: object - description: The $or's $not. - x-schemaName: RegExp - - type: object - description: The $or's $not. - - type: array - description: The $or's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The $or's $gt. - - type: object - description: The $or's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The $or's $gte. - - type: object - description: The $or's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The $or's $lt. - - type: object - description: The $or's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The $or's $lte. - - type: object - description: The $or's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The $or's $like. - $re: - type: string - title: $re - description: The $or's $re. - $ilike: - type: string - title: $ilike - description: The $or's $ilike. - $fulltext: - type: string - title: $fulltext - description: The $or's $fulltext. - $overlap: - type: array - description: The $or's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The $or's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The $or's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The $or's $exists. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $or's exec. - test: - type: object - description: The $or's test. - source: - type: string - title: source - description: The $or's source. - global: - type: boolean - title: global - description: The $or's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $or's ignorecase. - multiline: - type: boolean - title: multiline - description: The $or's multiline. - lastIndex: - type: number - title: lastIndex - description: The $or's lastindex. - compile: - type: object - description: The $or's compile. - flags: - type: string - title: flags - description: The $or's flags. - sticky: - type: boolean - title: sticky - description: The $or's sticky. - unicode: - type: boolean - title: unicode - description: The $or's unicode. - dotAll: - type: boolean - title: dotAll - description: The $or's dotall. - __@match@1165: - type: object - description: The $or's @match@1165. - __@replace@1167: - type: object - description: The $or's @replace@1167. - __@search@1170: - type: object - description: The $or's @search@1170. - __@split@1172: - type: object - description: The $or's @split@1172. - __@matchAll@1174: - type: object - description: The $or's @matchall@1174. + type: object $eq: oneOf: - type: string title: $eq - description: The deleted at's $eq. - - type: object - description: The deleted at's $eq. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + description: Filter by an exact match. - type: array - description: The deleted at's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $eq's exec. - test: - type: object - description: The $eq's test. - source: - type: string - title: source - description: The $eq's source. - global: - type: boolean - title: global - description: The $eq's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $eq's ignorecase. - multiline: - type: boolean - title: multiline - description: The $eq's multiline. - lastIndex: - type: number - title: lastIndex - description: The $eq's lastindex. - compile: - type: object - description: The $eq's compile. - flags: - type: string - title: flags - description: The $eq's flags. - sticky: - type: boolean - title: sticky - description: The $eq's sticky. - unicode: - type: boolean - title: unicode - description: The $eq's unicode. - dotAll: - type: boolean - title: dotAll - description: The $eq's dotall. - __@match@1165: - type: object - description: The $eq's @match@1165. - __@replace@1167: - type: object - description: The $eq's @replace@1167. - __@search@1170: - type: object - description: The $eq's @search@1170. - __@split@1172: - type: object - description: The $eq's @split@1172. - __@matchAll@1174: - type: object - description: The $eq's @matchall@1174. + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The deleted at's $ne. - - type: object - description: The deleted at's $ne. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $ne's exec. - test: - type: object - description: The $ne's test. - source: - type: string - title: source - description: The $ne's source. - global: - type: boolean - title: global - description: The $ne's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $ne's ignorecase. - multiline: - type: boolean - title: multiline - description: The $ne's multiline. - lastIndex: - type: number - title: lastIndex - description: The $ne's lastindex. - compile: - type: object - description: The $ne's compile. - flags: - type: string - title: flags - description: The $ne's flags. - sticky: - type: boolean - title: sticky - description: The $ne's sticky. - unicode: - type: boolean - title: unicode - description: The $ne's unicode. - dotAll: - type: boolean - title: dotAll - description: The $ne's dotall. - __@match@1165: - type: object - description: The $ne's @match@1165. - __@replace@1167: - type: object - description: The $ne's @replace@1167. - __@search@1170: - type: object - description: The $ne's @search@1170. - __@split@1172: - type: object - description: The $ne's @split@1172. - __@matchAll@1174: - type: object - description: The $ne's @matchall@1174. + type: string + title: $ne $in: type: array description: The deleted at's $in. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $in's exec. - test: - type: object - description: The $in's test. - source: - type: string - title: source - description: The $in's source. - global: - type: boolean - title: global - description: The $in's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $in's ignorecase. - multiline: - type: boolean - title: multiline - description: The $in's multiline. - lastIndex: - type: number - title: lastIndex - description: The $in's lastindex. - compile: - type: object - description: The $in's compile. - flags: - type: string - title: flags - description: The $in's flags. - sticky: - type: boolean - title: sticky - description: The $in's sticky. - unicode: - type: boolean - title: unicode - description: The $in's unicode. - dotAll: - type: boolean - title: dotAll - description: The $in's dotall. - __@match@1165: - type: object - description: The $in's @match@1165. - __@replace@1167: - type: object - description: The $in's @replace@1167. - __@search@1170: - type: object - description: The $in's @search@1170. - __@split@1172: - type: object - description: The $in's @split@1172. - __@matchAll@1174: - type: object - description: The $in's @matchall@1174. + type: string + title: $in $nin: type: array description: The deleted at's $nin. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $nin's exec. - test: - type: object - description: The $nin's test. - source: - type: string - title: source - description: The $nin's source. - global: - type: boolean - title: global - description: The $nin's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $nin's ignorecase. - multiline: - type: boolean - title: multiline - description: The $nin's multiline. - lastIndex: - type: number - title: lastIndex - description: The $nin's lastindex. - compile: - type: object - description: The $nin's compile. - flags: - type: string - title: flags - description: The $nin's flags. - sticky: - type: boolean - title: sticky - description: The $nin's sticky. - unicode: - type: boolean - title: unicode - description: The $nin's unicode. - dotAll: - type: boolean - title: dotAll - description: The $nin's dotall. - __@match@1165: - type: object - description: The $nin's @match@1165. - __@replace@1167: - type: object - description: The $nin's @replace@1167. - __@search@1170: - type: object - description: The $nin's @search@1170. - __@split@1172: - type: object - description: The $nin's @split@1172. - __@matchAll@1174: - type: object - description: The $nin's @matchall@1174. + type: string + title: $nin $not: oneOf: - type: string title: $not - description: The deleted at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The deleted at's $not. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. - - type: object - description: The deleted at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. properties: $and: type: array description: The $not's $and. items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp + type: object + title: $and $or: type: array description: The $not's $or. items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp + type: object + title: $or $eq: oneOf: - type: string title: $eq - description: The $not's $eq. - - type: object - description: The $not's $eq. - x-schemaName: RegExp + description: Filter by an exact match. - type: array - description: The $not's $eq. + description: Filter by an exact match. items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp + type: string + title: $eq + description: Filter by an exact match. $ne: - oneOf: - - type: string - title: $ne - description: The $not's $ne. - - type: object - description: The $not's $ne. - x-schemaName: RegExp + type: string + title: $ne + description: Filter by values not equal to this parameter. $in: type: array - description: The $not's $in. + description: Filter by values in this array. items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp + type: string + title: $in + description: Filter by values in this array. $nin: type: array - description: The $not's $nin. + description: Filter by values not in this array. items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp + type: string + title: $nin + description: Filter by values not in this array. $not: oneOf: - type: string title: $not - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: object - description: The $not's details. - x-schemaName: RegExp - - type: object - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. - type: array - description: The $not's details. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The $not's $gt. - - type: object - description: The $not's $gt. - x-schemaName: RegExp + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. $gte: - oneOf: - - type: string - title: $gte - description: The $not's $gte. - - type: object - description: The $not's $gte. - x-schemaName: RegExp + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. $lt: - oneOf: - - type: string - title: $lt - description: The $not's $lt. - - type: object - description: The $not's $lt. - x-schemaName: RegExp + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for + numbers and dates only. $lte: - oneOf: - - type: string - title: $lte - description: The $not's $lte. - - type: object - description: The $not's $lte. - x-schemaName: RegExp + 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: The $not's $like. + description: Apply a `like` filter. Useful for strings only. $re: type: string title: $re - description: The $not's $re. + description: Apply a regex filter. Useful for strings only. $ilike: type: string title: $ilike - description: The $not's $ilike. + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. $fulltext: type: string title: $fulltext - description: The $not's $fulltext. + description: Filter to apply on full-text properties. $overlap: type: array - description: The $not's $overlap. + description: >- + Filter arrays that have overlapping values with this + parameter. items: type: string title: $overlap - description: The $overlap's details. + description: >- + Filter arrays that have overlapping values with this + parameter. $contains: type: array - description: The $not's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. items: type: string title: $contains - description: The $contain's $contains. + description: >- + Filter arrays that contain some of the values of this + parameter. $contained: type: array - description: The $not's $contained. + description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: The $contained's details. + description: Filter arrays that contain all values of this parameter. $exists: type: boolean title: $exists - description: The $not's $exists. + description: >- + Filter by whether a value for this parameter exists (not + `null`). - type: array - description: The deleted at's $not. + description: >- + Filter by values not matching the conditions in this + parameter. items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $not's exec. - test: - type: object - description: The $not's test. - source: - type: string - title: source - description: The $not's source. - global: - type: boolean - title: global - description: The $not's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $not's ignorecase. - multiline: - type: boolean - title: multiline - description: The $not's multiline. - lastIndex: - type: number - title: lastIndex - description: The $not's lastindex. - compile: - type: object - description: The $not's compile. - flags: - type: string - title: flags - description: The $not's flags. - sticky: - type: boolean - title: sticky - description: The $not's sticky. - unicode: - type: boolean - title: unicode - description: The $not's unicode. - dotAll: - type: boolean - title: dotAll - description: The $not's dotall. - __@match@1165: - type: object - description: The $not's @match@1165. - __@replace@1167: - type: object - description: The $not's @replace@1167. - __@search@1170: - type: object - description: The $not's @search@1170. - __@split@1172: - type: object - description: The $not's @split@1172. - __@matchAll@1174: - type: object - description: The $not's @matchall@1174. + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. $gt: - oneOf: - - type: string - title: $gt - description: The deleted at's $gt. - - type: object - description: The deleted at's $gt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gt's exec. - test: - type: object - description: The $gt's test. - source: - type: string - title: source - description: The $gt's source. - global: - type: boolean - title: global - description: The $gt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gt's lastindex. - compile: - type: object - description: The $gt's compile. - flags: - type: string - title: flags - description: The $gt's flags. - sticky: - type: boolean - title: sticky - description: The $gt's sticky. - unicode: - type: boolean - title: unicode - description: The $gt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gt's dotall. - __@match@1165: - type: object - description: The $gt's @match@1165. - __@replace@1167: - type: object - description: The $gt's @replace@1167. - __@search@1170: - type: object - description: The $gt's @search@1170. - __@split@1172: - type: object - description: The $gt's @split@1172. - __@matchAll@1174: - type: object - description: The $gt's @matchall@1174. + type: string + title: $gt $gte: - oneOf: - - type: string - title: $gte - description: The deleted at's $gte. - - type: object - description: The deleted at's $gte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $gte's exec. - test: - type: object - description: The $gte's test. - source: - type: string - title: source - description: The $gte's source. - global: - type: boolean - title: global - description: The $gte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $gte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $gte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $gte's lastindex. - compile: - type: object - description: The $gte's compile. - flags: - type: string - title: flags - description: The $gte's flags. - sticky: - type: boolean - title: sticky - description: The $gte's sticky. - unicode: - type: boolean - title: unicode - description: The $gte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $gte's dotall. - __@match@1165: - type: object - description: The $gte's @match@1165. - __@replace@1167: - type: object - description: The $gte's @replace@1167. - __@search@1170: - type: object - description: The $gte's @search@1170. - __@split@1172: - type: object - description: The $gte's @split@1172. - __@matchAll@1174: - type: object - description: The $gte's @matchall@1174. + type: string + title: $gte $lt: - oneOf: - - type: string - title: $lt - description: The deleted at's $lt. - - type: object - description: The deleted at's $lt. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lt's exec. - test: - type: object - description: The $lt's test. - source: - type: string - title: source - description: The $lt's source. - global: - type: boolean - title: global - description: The $lt's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lt's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lt's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lt's lastindex. - compile: - type: object - description: The $lt's compile. - flags: - type: string - title: flags - description: The $lt's flags. - sticky: - type: boolean - title: sticky - description: The $lt's sticky. - unicode: - type: boolean - title: unicode - description: The $lt's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lt's dotall. - __@match@1165: - type: object - description: The $lt's @match@1165. - __@replace@1167: - type: object - description: The $lt's @replace@1167. - __@search@1170: - type: object - description: The $lt's @search@1170. - __@split@1172: - type: object - description: The $lt's @split@1172. - __@matchAll@1174: - type: object - description: The $lt's @matchall@1174. + type: string + title: $lt $lte: - oneOf: - - type: string - title: $lte - description: The deleted at's $lte. - - type: object - description: The deleted at's $lte. - x-schemaName: RegExp - required: - - exec - - test - - source - - global - - ignoreCase - - multiline - - lastIndex - - flags - - sticky - - unicode - - dotAll - - __@match@1165 - - __@replace@1167 - - __@search@1170 - - __@matchAll@1174 - properties: - exec: - type: object - description: The $lte's exec. - test: - type: object - description: The $lte's test. - source: - type: string - title: source - description: The $lte's source. - global: - type: boolean - title: global - description: The $lte's global. - ignoreCase: - type: boolean - title: ignoreCase - description: The $lte's ignorecase. - multiline: - type: boolean - title: multiline - description: The $lte's multiline. - lastIndex: - type: number - title: lastIndex - description: The $lte's lastindex. - compile: - type: object - description: The $lte's compile. - flags: - type: string - title: flags - description: The $lte's flags. - sticky: - type: boolean - title: sticky - description: The $lte's sticky. - unicode: - type: boolean - title: unicode - description: The $lte's unicode. - dotAll: - type: boolean - title: dotAll - description: The $lte's dotall. - __@match@1165: - type: object - description: The $lte's @match@1165. - __@replace@1167: - type: object - description: The $lte's @replace@1167. - __@search@1170: - type: object - description: The $lte's @search@1170. - __@split@1172: - type: object - description: The $lte's @split@1172. - __@matchAll@1174: - type: object - description: The $lte's @matchall@1174. + type: string + title: $lte $like: type: string title: $like diff --git a/www/apps/api-reference/specs/store/paths/store_return.yaml b/www/apps/api-reference/specs/store/paths/store_return.yaml index 41714127f7..dbe3617283 100644 --- a/www/apps/api-reference/specs/store/paths/store_return.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return.yaml @@ -3,62 +3,7 @@ post: summary: Create Return description: Create a return. x-authenticated: false - parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - 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 `-`. - required: false - schema: - 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 `-`. + parameters: [] requestBody: content: application/json: @@ -90,3 +35,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + x-workflow: createAndCompleteReturnOrderWorkflow diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index f0da4511d2..1ade16eb30 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -6,37 +6,36 @@ info: name: MIT url: https://github.com/medusajs/medusa/blob/develop/LICENSE tags: - - name: Auth - description: > - Auth API routes allow you to manage an admin user's authentication. - externalDocs: - description: Learn more about the Auth Module - url: https://docs.medusajs.com/v2/resources/commerce-modules/auth - name: Api Keys description: > API keys can be used for authentication or resource-scoping. - A secret API key can be used to authenticate admin users. - A publishable API key can be used to scope client requests to one or more sales channels. + A secret API key can be used to authenticate admin users. A publishable API key can be used to scope client requests to one or more sales channels. These API routes allow admin users to manage both publishable and secret API keys. externalDocs: description: Learn more about the API Key Module url: https://docs.medusajs.com/v2/resources/commerce-modules/api-key + x-associatedSchema: + $ref: "#/components/schemas/AdminApiKey" - name: Campaigns description: > - A campaign is a group of promotions that have the same conditions, such as start and end dates. + A campaign is a group of promotions that have the same conditions, such as + start and end dates. These API routes allow admin users to manage campaigns, their conditions, and promotions that belong to them. externalDocs: description: Learn more about campaigns. url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/campaign + x-associatedSchema: + $ref: "#/components/schemas/AdminCampaign" - name: Claims description: > - An admin creates a claim for an order when a customer reports that an item is defective or incorrect. + An admin creates a claim for an order when a customer reports that an item + is defective or incorrect. Using these API routes, admin users manage order claims, their items, and more. @@ -47,7 +46,8 @@ tags: url: https://docs.medusajs.com/v2/resources/commerce-modules/order/claim - name: Collections description: > - A product collection organizes products into a collection for marketing purposes. For example, a summer collection. + A product collection organizes products into a collection for marketing + purposes. For example, a summer collection. These API routes allow admin users to manage collections and the products in them. @@ -67,11 +67,11 @@ tags: $ref: "#/components/schemas/AdminCurrency" - name: Customer Groups description: > - Customers can be organized into groups. These groups are useful for segregation and marketing purposes. + Customers can be organized into groups. These groups are useful for + segregation and marketing purposes. - For example, you can provide different prices for specific customers by creating a price list conditioned to their - group. + For example, you can provide different prices for specific customers by creating a price list conditioned to their group. These API routes allow admin users to manage groups and the customers in them. @@ -94,19 +94,19 @@ tags: $ref: "#/components/schemas/AdminCustomer" - name: Draft Orders description: > - A draft order is an order created by the admin user. This is useful for orders created offline or - from clients other than a storefront, such as a third-party integration. + A draft order is an order created by the admin user. This is useful for + orders created offline or from clients other than a storefront, such as a + third-party integration. These API routes allow admin users to create and manage draft orders. externalDocs: description: Learn more about the Order Module url: https://docs.medusajs.com/v2/resources/commerce-modules/order - x-associatedSchema: - $ref: "#/components/schemas/AdminOrder" - name: Exchanges description: > - An exchange is the replacement of an item that the customer ordered with another. + An exchange is the replacement of an item that the customer ordered with + another. These API routes allow admin users t create and manage exchanges. @@ -117,8 +117,8 @@ tags: $ref: "#/components/schemas/AdminExchange" - name: Fulfillment Providers description: > - A fulfillment provider is a third-party integration or custom logic used to - fulfill an order's items. + A fulfillment provider is a third-party integration or custom logic used + to fulfill an order's items. Fulfillment providers are installed as module providers. @@ -129,7 +129,8 @@ tags: $ref: "#/components/schemas/AdminFulfillmentProvider" - name: Fulfillment Sets description: > - A fulfillment set is a general form or way of fulfillment, such as "shipping" or "pick up". + A fulfillment set is a general form or way of fulfillment, such as + "shipping" or "pick up". All fulfillment-related configurations in a store are related to a fulfillment set. @@ -143,7 +144,8 @@ tags: $ref: "#/components/schemas/AdminFulfillmentSet" - name: Fulfillments description: > - A fulfillment is created for items in an order, return, exchanges, or claims to deliver items to/from the customer. + A fulfillment is created for items in an order, return, exchanges, or + claims to deliver items to/from the customer. These API routes allow admin users to manage fulfillments. @@ -153,10 +155,9 @@ tags: x-associatedSchema: $ref: "#/components/schemas/AdminFulfillment" - name: Inventory Items - description: > + description: | An inventory item is a stock-kept product whose inventory is managed. - These API routes allow admin users to manage inventory items. externalDocs: description: Learn more about inventory items. @@ -165,8 +166,8 @@ tags: $ref: "#/components/schemas/AdminInventoryItem" - name: Invites description: > - An admin can invite new users to manage their team. This allows new - users to authenticate as admins and perform admin functionalities. + An admin can invite new users to manage their team. This allows new users + to authenticate as admins and perform admin functionalities. These API routes allow admin users to manage invites. @@ -177,7 +178,8 @@ tags: $ref: "#/components/schemas/AdminInvite" - name: Notifications description: > - A notification informs an admin user of store changes or status changes of background tasks. + A notification informs an admin user of store changes or status changes of + background tasks. These API routes allow admin users to view and manage notifications. @@ -185,8 +187,9 @@ tags: $ref: "#/components/schemas/AdminNotification" - name: Order Edits description: > - An order edit is a change to an order's details, such as items, shipping methods, and more. - + An order edit is a change to an order's details, such as items, shipping + methods, and more. + Changes made by an order edit are only applied on the order once they're confirmed. @@ -198,16 +201,12 @@ tags: externalDocs: description: Learn more about the Order Module url: https://docs.medusajs.com/v2/resources/commerce-modules/order - x-associatedSchema: - $ref: "#/components/schemas/OrderChange" - name: Orders - description: > + description: | An order is a purchase made by a customer through a storefront. - Orders can also originally be created as draft orders. - These API routes allow admin users to view and manage orders. externalDocs: description: Learn more about the orders @@ -216,15 +215,14 @@ tags: $ref: "#/components/schemas/AdminOrder" - name: Payment Collections description: > - A payment collection is one or more payments of an order. They're also used for outstanding payments due to - order exchanges or claims. + A payment collection is one or more payments of an order. They're also + used for outstanding payments due to order exchanges or claims. Every purchase or request for payment starts with a payment collection. - A payment collection holds the payment sessions used to authorize the payment amount, and the payments to be - captured / refunded. + A payment collection holds the payment sessions used to authorize the payment amount, and the payments to be captured / refunded. These API routes allow admin users to manage payment collections. @@ -235,7 +233,8 @@ tags: $ref: "#/components/schemas/AdminPaymentCollection" - name: Payments description: > - A payment is created when a payment amount is authorized. The payment can then be captured or refunded. + A payment is created when a payment amount is authorized. The payment can + then be captured or refunded. A payment is created from the payment session that was authorized, and it belongs to the payment session's collection. @@ -249,7 +248,8 @@ tags: $ref: "#/components/schemas/AdminPayment" - name: Price Lists description: > - A price list is a group of prices applied if the specified conditions and rules are satisfied. + A price list is a group of prices applied if the specified conditions and + rules are satisfied. Price lists are useful for sales or special prices for special conditions, such as applying prices for a set of customers. @@ -263,7 +263,8 @@ tags: $ref: "#/components/schemas/AdminPriceList" - name: Price Preferences description: > - A price preference is used to specify whether tax-inclusiveness is enabled for a context, such as a region or currency code. + A price preference is used to specify whether tax-inclusiveness is enabled + for a context, such as a region or currency code. These API routes allow admin users to manage whether a region or currency is tax inclusive. @@ -277,8 +278,7 @@ tags: Products can be categorized into categories. - Categories are nested and their heirarchy can be managed, giving admin users flexibility in how they categorize - their products. + Categories are nested and their heirarchy can be managed, giving admin users flexibility in how they categorize their products. These API routes allow admin users to manage categories and the products in them. @@ -289,7 +289,8 @@ tags: $ref: "#/components/schemas/AdminProductCategory" - name: Product Tags description: > - A tag is another way of organizing a product. Each tag has a name and a value. + A tag is another way of organizing a product. Each tag has a name and a + value. Products are organized into the same tag if they have the same value. @@ -302,25 +303,23 @@ tags: x-associatedSchema: $ref: "#/components/schemas/AdminProductTag" - name: Product Types - description: > + description: | Products can be organized into types. Each type has a name and a value. - Products are organized into the same type if they have the same value. - These API routes allow admin users to manage product types. externalDocs: description: Learn more about the Product Module url: https://docs.medusajs.com/v2/resources/commerce-modules/product + x-associatedSchema: + $ref: "#/components/schemas/AdminProductType" - name: Product Variants description: > A product variant is a saleable form of the product. - Each variant has different option values. For example, a "Shirt" product may have a - "Blue" variant and a "Green" variant. Customers choose from these variants when they buy - the product. + Each variant has different option values. For example, a "Shirt" product may have a "Blue" variant and a "Green" variant. Customers choose from these variants when they buy the product. These API routes allow admin users to manage product variants. @@ -331,7 +330,8 @@ tags: $ref: "#/components/schemas/AdminProductVariant" - name: Products description: > - A product is a set of variants that the customer chooses from when making a purchase. + A product is a set of variants that the customer chooses from when making + a purchase. A product can be organized into categories or collections. @@ -348,11 +348,11 @@ tags: $ref: "#/components/schemas/AdminProduct" - name: Promotions description: > - A promotion discounts an amount or percentage off a cart's items, shipping methods, or the entire order. + A promotion discounts an amount or percentage off a cart's items, shipping + methods, or the entire order. - Promotions have different types, such as a `standard` promotion that just discounts an amount, or a `buyget` - promotion to enforce a "buy X get Y" promotion. + Promotions have different types, such as a `standard` promotion that just discounts an amount, or a `buyget` promotion to enforce a "buy X get Y" promotion. A promotion has rules to restrict how and when they're applied. @@ -369,8 +369,8 @@ tags: $ref: "#/components/schemas/AdminPromotion" - name: Refund Reasons description: > - A refund reason is a possible reason used when issuing a refund to the customer, such as when returning an item - and refunding the customer. + A refund reason is a possible reason used when issuing a refund to the + customer, such as when returning an item and refunding the customer. These API routes allow admin users to manage refund reasons. @@ -393,17 +393,19 @@ tags: A reservation is unavailable quantity of an inventory item in a location. - A reservation is created automatically for variants in an order whose `manage_inventory` is enabled. - Admin users can also create reservations manually. + A reservation is created automatically for variants in an order whose `manage_inventory` is enabled. Admin users can also create reservations manually. These API routes allow admin users to manage reservations. externalDocs: description: Learn more about reservations and other inventory concepts. url: https://docs.medusajs.com/v2/resources/commerce-modules/inventory/concepts + x-associatedSchema: + $ref: "#/components/schemas/AdminReservation" - name: Return Reasons description: > - A return reason is a possible reason that an item is returned from the customer, such as when returning an item. + A return reason is a possible reason that an item is returned from the + customer, such as when returning an item. These API routes allow admin users to manage return reasons. @@ -414,9 +416,7 @@ tags: Admin users create a return when a customer returns an item to them. - Returns can also be created by customers through the storefront, and admins will - be able to manage them and make refunds, if necessary. Refunds are made - through the [Payment API Routes](#payment) + Returns can also be created by customers through the storefront, and admins will be able to manage them and make refunds, if necessary. Refunds are made through the [Payment API Routes](#payment) These API routes allow admin users to manage returns. @@ -445,8 +445,7 @@ tags: Shipping options are associated with the fulfillment provider used to handle their fulfillment. - Shipping options can be restricted geographically by service zones, and by custom rules, such as an item's - weight or the customer's group. + Shipping options can be restricted geographically by service zones, and by custom rules, such as an item's weight or the customer's group. These API routes allow admins to manage shipping options. @@ -457,8 +456,9 @@ tags: $ref: "#/components/schemas/AdminShippingOption" - name: Shipping Profiles description: > - A shipping profile defines a type of items that are shipping in a similar manner. For example, - digital products may have a `digital` shipping profile. + A shipping profile defines a type of items that are shipping in a similar + manner. For example, digital products may have a `digital` shipping + profile. These API routes allow admin users to manage shipping profiles. @@ -475,8 +475,7 @@ tags: Stock locations are linked to fulfillment providers used to fulfill items from this location. - A stock location is also link to a fulfillment set, indicating where an item is fulfilled from - when an order is placed. + A stock location is also link to a fulfillment set, indicating where an item is fulfilled from when an order is placed. These API routes allow admin users to manage stock locations and their linked data. @@ -487,11 +486,11 @@ tags: $ref: "#/components/schemas/AdminStockLocation" - name: Stores description: > - A store holds the main configuration and information of your commerce store, such as supported currencies or default sales channel. + A store holds the main configuration and information of your commerce + store, such as supported currencies or default sales channel. - By default, the Medusa application has one default store. There are no API routes to create more stores. Instead, you'd have - to handle that customization manually. + By default, the Medusa application has one default store. There are no API routes to create more stores. Instead, you'd have to handle that customization manually. These API routes allow admin users to manage their store. @@ -502,7 +501,8 @@ tags: $ref: "#/components/schemas/AdminStore" - name: Tax Rates description: > - A tax rate is a percentage amount used to calculate the tax amount of each taxable item's price, such as line items or shipping methods. + A tax rate is a percentage amount used to calculate the tax amount of each + taxable item's price, such as line items or shipping methods. Each tax region has a default tax rate. You can create tax rates that override the default using tax rules. @@ -516,8 +516,8 @@ tags: $ref: "#/components/schemas/AdminTaxRate" - name: Tax Regions description: > - A tax region is a region's tax settings. It has tax rates and rules. So, after you create a region, - you must create a tax region for it. + A tax region is a region's tax settings. It has tax rates and rules. So, + after you create a region, you must create a tax region for it. A tax region can extend settings from a parent tax region. @@ -531,22 +531,21 @@ tags: $ref: "#/components/schemas/AdminTaxRegion" - name: Uploads description: > - Use these API routes to upload files to your Medusa application using the installed file module provider. + Use these API routes to upload files to your Medusa application using the + installed file module provider. You can upload public files, such as product images, or private files, such as CSV files used to import products. externalDocs: description: Check out available file module providers. url: https://docs.medusajs.com/v2/resources/architectural-modules/file - x-associatedSchema: - $ref: "#/components/schemas/AdminFile" - name: Users description: > - A user is an admin user that can authenticate and perform functionalities as an admin user. + A user is an admin user that can authenticate and perform functionalities + as an admin user. - An admin user can invite other users to join their team. Once they accept the invite, they'll - become admin users as well. + An admin user can invite other users to join their team. Once they accept the invite, they'll become admin users as well. These API routes allow admin users to manage their team. @@ -557,16 +556,14 @@ tags: $ref: "#/components/schemas/AdminUser" - name: Workflows Executions description: > - These API routes allow you to track workflow executions in your Medusa application. + These API routes allow you to track workflow executions in your Medusa + application. - Depending on the workflow engine you use, executions may only be retained for a short while, or - only until the Medusa application is restarted. + Depending on the workflow engine you use, executions may only be retained for a short while, or only until the Medusa application is restarted. externalDocs: description: Check out available Workflow Engine Modules url: https://docs.medusajs.com/v2/resources/architectural-modules/workflow-engine - x-associatedSchema: - $ref: "#/components/schemas/AdminWorkflowExecution" servers: - url: http://localhost:9000 - url: https://api.medusajs.com diff --git a/www/utils/generated/oas-output/base/store.oas.base.yaml b/www/utils/generated/oas-output/base/store.oas.base.yaml index 9426bd6e0f..0b4ed23fc6 100644 --- a/www/utils/generated/oas-output/base/store.oas.base.yaml +++ b/www/utils/generated/oas-output/base/store.oas.base.yaml @@ -6,12 +6,6 @@ info: name: MIT url: https://github.com/medusajs/medusa/blob/master/LICENSE tags: - - name: Auth - description: > - Auth API routes allow you to manage a customer's authentication. - externalDocs: - description: How to register a customer in a storefront. - url: https://docs.medusajs.com/v2/resources/storefront-development/customers/register - name: Carts description: > A cart is a virtual shopping bag that customers can use to add items they @@ -29,7 +23,8 @@ tags: $ref: "#/components/schemas/StoreCart" - name: Collections description: > - A product collection organizes products into a collection for marketing purposes. For example, a summer collection. + A product collection organizes products into a collection for marketing + purposes. For example, a summer collection. These API routes allow customers to browse collections and their products. @@ -40,7 +35,8 @@ tags: $ref: "#/components/schemas/StoreCollection" - name: Currencies description: > - A store has multiple currencies, and product prices can be different for each currency. + A store has multiple currencies, and product prices can be different for + each currency. When retrieving product variant prices, you specify either the ID of a region or a currency that the customer selected. @@ -67,10 +63,9 @@ tags: x-associatedSchema: $ref: "#/components/schemas/StoreCustomer" - name: Orders - description: > + description: | Guest and registered customers can view orders they placed. - These API routes allow customers to view their orders. x-associatedSchema: $ref: "#/components/schemas/StoreOrder" @@ -79,8 +74,7 @@ tags: A cart must have a payment collection with an authorized payment session. - Use these API routes during checkout to set the cart's payment provider and authorize its - payment session. + Use these API routes during checkout to set the cart's payment provider and authorize its payment session. externalDocs: description: How to implement payment during checkout. url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment @@ -91,9 +85,7 @@ tags: Each region has a set of payment providers enabled. - During checkout, you retrieve the available payment providers in the customer's region to - show them to the customer. Customers then choose their preferred provider to authorize their - payment and place their order. + During checkout, you retrieve the available payment providers in the customer's region to show them to the customer. Customers then choose their preferred provider to authorize their payment and place their order. These API routes allow customers to view available payment providers in their region. @@ -103,10 +95,9 @@ tags: x-associatedSchema: $ref: "#/components/schemas/StorePaymentProvider" - name: Product Categories - description: > + description: | Products can be categorized into categories. - These API routes allow customers to browse categories and their products. externalDocs: description: How to list product categories in a storefront. @@ -118,8 +109,7 @@ tags: Customers browse products for their purchase. - A product has variants for different option values. The customer chooses from these variants - before adding it to the cart. + A product has variants for different option values. The customer chooses from these variants before adding it to the cart. These API routes allow customers to browse products. @@ -145,7 +135,8 @@ tags: $ref: "#/components/schemas/StoreRegion" - name: Return description: > - Customers can request to return items in their order. The admin user then receives and handles the return. + Customers can request to return items in their order. The admin user then + receives and handles the return. These API routes allows customers to create a return. @@ -156,8 +147,7 @@ tags: A return reason is a possible reason a customer wants to return an item. - Use these API routes when implementing return creation flow in your storefront to allow customers to - select their return reason. + Use these API routes when implementing return creation flow in your storefront to allow customers to select their return reason. x-associatedSchema: $ref: "#/components/schemas/StoreReturnReason" - name: Shipping Options @@ -349,4 +339,4 @@ components: type: apiKey x-displayName: Cookie Session ID in: cookie - name: connect.sid \ No newline at end of file + name: connect.sid diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts index 3605a875c9..44405aebc8 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts @@ -2,7 +2,7 @@ * @oas [delete] /admin/api-keys/{id} * operationId: DeleteApiKeysId * summary: Delete an Api Key - * description: > + * description: | * Delete a publishable or secret API key. * x-authenticated: true * parameters: @@ -12,56 +12,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -95,7 +45,7 @@ * type: string * title: object * description: The name of the object that was deleted. - * default: "api_key" + * default: api_key * deleted: * type: boolean * title: deleted @@ -115,6 +65,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteApiKeysWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts index 913eae4b7b..a039478fec 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts @@ -2,7 +2,7 @@ * @oas [delete] /admin/campaigns/{id} * operationId: DeleteCampaignsId * summary: Delete a Campaign - * description: > + * description: | * Delete a campaign by its ID. This doesn't delete promotions that belong to this campaign. * x-authenticated: true * parameters: @@ -12,56 +12,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -95,7 +45,7 @@ * type: string * title: object * description: The name of the object that was deleted. - * default: "campaign" + * default: campaign * deleted: * type: boolean * title: deleted @@ -115,6 +65,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteCampaignsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts index 4843958c63..4dbd033eb3 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteClaimsIdClaimItemsAction_id * summary: Remove a Claim Item from a Claim * x-sidebar-summary: Remove Claim Item - * description: > + * description: | * Remove an order item from a claim by the ID of the item's `WRITE_OFF_ITEM` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -33,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -63,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts index fea08a8be4..637c146e48 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteClaimsIdInboundItemsAction_id * summary: Remove an Inbound Item from Claim * x-sidebar-summary: Remove Inbound Item - * description: > + * description: | * Remove an inbound (or return) item from a claim using the `ID` of the item's `RETURN_ITEM` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -33,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -63,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,9 +70,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Claims * responses: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts index fac42fc87e..cf47876bbe 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteClaimsIdInboundShippingMethodAction_id * summary: Remove Inbound Shipping Method from Claim * x-sidebar-summary: Remove Inbound Shipping Method - * description: > + * description: | * Remove the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action. * - * - * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -23,56 +21,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,9 +28,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Claims * responses: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts index 55ec30ae2d..28f539a64a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteClaimsIdOutboundItemsAction_id * summary: Remove an Outbound Item from Claim * x-sidebar-summary: Remove Outbound Item - * description: > + * description: | * Remove an outbound (or new) item from a claim using the `ID` of the item's `ITEM_ADD` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -33,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -63,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,9 +70,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Claims * responses: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts index b006c6bf43..6f1446b837 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteClaimsIdOutboundShippingMethodAction_id * summary: Remove Outbound Shipping Method from Claim * x-sidebar-summary: Remove Outbound Shipping Method - * description: > + * description: | * Remove the shipping method for delivering outbound items in the claim using the `ID` of the method's `SHIPPING_ADD` action. * - * - * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -33,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -63,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,9 +70,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Claims * responses: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts index 6d002d0b44..8e72bc2c44 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelBeginOrderClaimWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts index 52fe653f02..6a8678832c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteCollectionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts index f640db5bf9..cefe91930f 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts @@ -2,7 +2,7 @@ * @oas [delete] /admin/customer-groups/{id} * operationId: DeleteCustomerGroupsId * summary: Delete a Customer Group - * description: > + * description: | * Delete a customer group. Customers in the group aren't deleted. * x-authenticated: true * parameters: @@ -12,56 +12,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteCustomerGroupsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts index 6244914505..a447d37d90 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +63,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteCustomersWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index 615c39c570..0aea4a23b3 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -74,9 +66,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Customers * responses: @@ -119,6 +109,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteCustomerAddressesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts index 2801c7d696..d26cb27099 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteExchangesIdInboundItemsAction_id * summary: Remove Inbound Item from Exchange * x-sidebar-summary: Remove Inbound Item - * description: > + * description: | * Remove an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -33,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -63,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,9 +70,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Exchanges * responses: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index 38487b3ef8..45cdc71a0d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteExchangesIdInboundShippingMethodAction_id * summary: Remove Inbound Shipping Method from Exchange * x-sidebar-summary: Remove Inbound Shipping Method - * description: > + * description: | * Remove the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. * - * - * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -23,56 +21,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,9 +28,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Exchanges * responses: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts index 7b7d579e00..0c655ef219 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteExchangesIdOutboundItemsAction_id * summary: Remove Outbound Item from Exchange * x-sidebar-summary: Remove Outbound Item - * description: > + * description: | * Remove an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -33,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -63,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,9 +70,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Exchanges * responses: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index fd8472e7bd..c5694ce1f0 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteExchangesIdOutboundShippingMethodAction_id * summary: Remove Outbound Shipping Method from Exchange * x-sidebar-summary: Remove Outbound Shipping Method - * description: > + * description: | * Remove the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. * - * - * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -33,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -63,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,9 +70,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Exchanges * responses: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts index ce593cbd8f..33d23645b7 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "exchange" + * default: exchange * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelBeginOrderExchangeWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts index 407b97172f..66acaa430a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteFulfillmentSetsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 903a466202..4215f2f721 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -18,56 +18,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -75,9 +25,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Fulfillment Sets * responses: @@ -121,6 +69,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteServiceZonesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts index 491adfb042..23d1aff694 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "inventory_item" + * default: inventory_item * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteInventoryItemWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts index 00b44538ae..80a41014ce 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -3,10 +3,9 @@ * operationId: DeleteInventoryItemsIdLocationLevelsLocation_id * summary: Remove Inventory Level of Inventory Item * x-sidebar-summary: Remove Inventory Level - * description: > + * description: | * Remove the inventory level of an inventory item. * - * * If the inventory level has reserved quantity greater than `0`, an error is thrown. * x-authenticated: true * parameters: @@ -32,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -62,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,9 +70,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: "curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \\ -H 'x-medusa-access-token: {api_token}'" * tags: * - Inventory Items * responses: @@ -125,6 +114,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteInventoryLevelsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts index 06d965477b..861b88b397 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -88,7 +38,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "invite" + * default: invite * deleted: * type: boolean * title: deleted @@ -108,6 +58,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteInvitesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts index 0795874c9d..62c995eda7 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,11 +44,14 @@ * type: string * title: object * description: The name of the deleted object. - * default: "order-edit" + * default: order-edit * deleted: * type: boolean * title: deleted * description: Whether the order edit was deleted. + * parent: + * type: object + * description: The order edit's parent. * "400": * $ref: "#/components/responses/400_error" * "401": @@ -111,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelBeginOrderEditWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts index 9131807352..78cde1af96 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_items_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteOrderEditsIdItemsAction_id * summary: Remove Item from Order Edit * x-sidebar-summary: Remove Item - * description: > + * description: | * Remove an added item in the order edit by the ID of the item's `ITEM_ADD` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -23,56 +21,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts index 3ec6e1af51..f8098efaac 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id]_shipping-method_[action_id].ts @@ -3,12 +3,10 @@ * operationId: DeleteOrderEditsIdShippingMethodAction_id * summary: Remove Shipping Method from Order Edit * x-sidebar-summary: Remove Shipping Method - * description: > + * description: | * Remove a shipping method in the order edit by the ID of the method's `SHIPPING_ADD` action. * - * - * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -23,56 +21,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -80,10 +28,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE - * '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ - * + * source: |- + * curl -X DELETE '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Order Edits diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts index 24fe1a9ec3..e4bccb653b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,11 +44,14 @@ * type: string * title: object * description: The name of the deleted object. - * default: "payment-collection" + * default: payment-collection * deleted: * type: boolean * title: deleted * description: Whether the payment collection was deleted. + * parent: + * type: object + * description: The payment collection's parent. * "400": * $ref: "#/components/responses/400_error" * "401": @@ -111,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteOrderPaymentCollections * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts index 0a35498989..da0417a295 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deletePriceListsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts index 16036691e8..fc624655c5 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_price-preferences_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deletePricePreferencesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts index 597c29e834..c9b863e1b3 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteProductCategoriesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts index e30e055eb3..0a72eac111 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteProductTagsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts index a9072d02b5..fee7b7cd79 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteProductTypesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts index c9329c1984..cba2ea38c2 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteProductsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts index f8566c2360..3f4b3f758d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts @@ -3,10 +3,9 @@ * operationId: DeleteProductsIdOptionsOption_id * summary: Delete an Option from Product * x-sidebar-summary: Delete Option - * description: > + * description: | * Delete an option from a product. * - * * Values of this option in the product's variants are removed. * x-authenticated: true * parameters: @@ -32,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -62,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -103,6 +94,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteProductOptionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts index 04710e3f55..80fa04bb46 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts @@ -28,18 +28,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +54,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -99,6 +91,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteProductVariantsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts index 15423b22e3..017db1698f 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -34,18 +34,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -64,16 +60,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -81,11 +73,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE - * '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' - * \ - * + * source: |- + * curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Products diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts index f8258cb650..2542fc43d1 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "promotion" + * default: promotion * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deletePromotionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts index 969dc98229..9658ebacd0 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "refund_reason" + * default: refund_reason * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteReturnReasonsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts index 84fd17a3b4..865220e2f0 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "region" + * default: region * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteRegionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts index f00085f142..c581c89158 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "reservation" + * default: reservation * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteReservationsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts index eabea72526..bdcb12e4f6 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "return_reason" + * default: return_reason * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteReturnReasonsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts index 8704ba61c1..f0490106da 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts @@ -3,14 +3,10 @@ * operationId: DeleteReturnsIdDismissItemsAction_id * summary: Remove Damaged Item from Return * x-sidebar-summary: Remove Damaged Item - * description: > - * Remove a damaged item, whose quantity is to be dismissed, in the return by the ID of the - * item's `RECEIVE_DAMAGED_RETURN_ITEM` action. + * description: | + * Remove a damaged item, whose quantity is to be dismissed, in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. - * return. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. * x-authenticated: true * parameters: * - name: id @@ -35,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -65,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -82,10 +70,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE - * '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ - * + * source: |- + * curl -X DELETE '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Returns diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts index 84f5f91d82..0aa1188316 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts @@ -3,14 +3,10 @@ * operationId: DeleteReturnsIdReceiveItemsAction_id * summary: Remove a Received Item from Return * x-sidebar-summary: Remove Received Item - * description: > - * Remove an item marked as received in the return by the ID of the - * item's `RECEIVE_RETURN_ITEM` action. + * description: | + * Remove an item marked as received in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. - * return. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. * x-authenticated: true * parameters: * - name: id @@ -35,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -65,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -82,10 +70,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE - * '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ - * + * source: |- + * curl -X DELETE '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Returns diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts index 7f115dd624..accc5ae1cf 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the returned object. - * default: "return" + * default: return * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelReturnReceiveWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts index 6b84def5e5..51cc57e2e4 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts @@ -3,14 +3,10 @@ * operationId: DeleteReturnsIdRequestItemsAction_id * summary: Remove Item from Return * x-sidebar-summary: Remove Item - * description: > - * Remove an item in the return by the ID of the - * item's `RETURN_ITEM` action. + * description: | + * Remove an item in the return by the ID of the item's `RETURN_ITEM` action. * - * - * Every item has an `actions` property, whose value is an array of actions. You can check the action's - * name using its `action` property, and use the value of the `id` property. - * return. + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. * x-authenticated: true * parameters: * - name: id @@ -35,18 +31,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -65,16 +57,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -82,10 +70,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE - * '{backend_url}/admin/returns/{id}/request-items/{action_id}' \ - * + * source: |- + * curl -X DELETE '{backend_url}/admin/returns/{id}/request-items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Returns diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts index a7bf618952..7ddaf7362b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +44,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "return" + * default: return * deleted: * type: boolean * title: deleted @@ -114,6 +64,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelReturnRequestWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts index 010d377636..2b03f3c90a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts @@ -2,9 +2,7 @@ * @oas [delete] /admin/returns/{id}/shipping-method/{action_id} * operationId: DeleteReturnsIdShippingMethodAction_id * summary: Remove Shipping Methods from Return - * description: Remove a list of shipping methods from a return. This doesn't - * delete the Shipping Method, only the association between the Shipping Method - * and the return. + * description: Remove a list of shipping methods from a return. This doesn't delete the Shipping Method, only the association between the Shipping Method and the return. * x-authenticated: true * parameters: * - name: id @@ -29,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -59,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -76,10 +66,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X DELETE - * '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \ - * + * source: |- + * curl -X DELETE '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Returns diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts index 89de824de5..636706975b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteSalesChannelsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts index 924059a47c..b3efb71155 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteShippingOptionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts index 6b617da781..3caaf8a3c7 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteShippingProfileWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts index 39e7937150..273fc76c34 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteStockLocationsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts index c01a2b1fbc..027a9a2447 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteTaxRatesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts index 998589ede1..935aceebdd 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts @@ -2,8 +2,7 @@ * @oas [delete] /admin/tax-rates/{id}/rules/{rule_id} * operationId: DeleteTaxRatesIdRulesRule_id * summary: Remove Rules from Tax Rate - * description: Remove a list of rules from a tax rate. This doesn't delete the - * Rule, only the association between the Rule and the tax rate. + * description: Remove a list of rules from a tax rate. This doesn't delete the Rule, only the association between the Rule and the tax rate. * x-authenticated: true * parameters: * - name: id @@ -28,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -120,6 +111,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteTaxRateRulesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts index 01d3c461e5..ad2033fdd5 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -92,6 +42,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteTaxRegionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts index e66b6b0dbf..a968e9a4f7 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +63,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteFilesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts index 87ed7ba83d..5b5282b316 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -86,6 +36,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteUsersWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts index d67024cdb5..ff43c36446 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/api-keys * operationId: GetApiKeys * summary: List Api Keys - * description: Retrieve a list of api keys. The api keys can be filtered by fields - * such as `id`. The api keys can also be sorted or paginated. + * description: Retrieve a list of api keys. The api keys can be filtered by fields such as `id`. The api keys can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts index 89358cf82c..558e8a9e56 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/api-keys/{id} * operationId: GetApiKeysId * summary: Get a Api Key - * description: Retrieve a api key by its ID. You can expand the api key's - * relations or select the fields that should be returned. + * description: Retrieve a api key by its ID. You can expand the api key's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts index 14666f3bb1..e3b06d5b49 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/campaigns * operationId: GetCampaigns * summary: List Campaigns - * description: Retrieve a list of campaigns. The campaigns can be filtered by - * fields such as `id`. The campaigns can also be sorted or paginated. + * description: Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts index 49da297f7e..4850f8da66 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/campaigns/{id} * operationId: GetCampaignsId * summary: Get a Campaign - * description: Retrieve a campaign by its ID. You can expand the campaign's - * relations or select the fields that should be returned. + * description: Retrieve a campaign by its ID. You can expand the campaign's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts index 90b0899b65..4712376d39 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/claims * operationId: GetClaims * summary: List Claims - * description: Retrieve a list of claims. The claims can be filtered by fields - * such as `id`. The claims can also be sorted or paginated. + * description: Retrieve a list of claims. The claims can be filtered by fields such as `id`. The claims can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts index a4e461a355..1233e57bbb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/claims/{id} * operationId: GetClaimsId * summary: Get a Claim - * description: Retrieve a claim by its ID. You can expand the claim's relations or - * select the fields that should be returned. + * description: Retrieve a claim by its ID. You can expand the claim's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts index 1f23aa208d..03d2ef12b1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/collections * operationId: GetCollections * summary: List Collections - * description: Retrieve a list of collections. The collections can be filtered by - * fields such as `id`. The collections can also be sorted or paginated. + * description: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts index d43942f30a..f3f1972f42 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/collections/{id} * operationId: GetCollectionsId * summary: Get a Collection - * description: Retrieve a collection by its ID. You can expand the collection's - * relations or select the fields that should be returned. + * description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts index a23087fc13..e122c3e8e9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/currencies * operationId: GetCurrencies * summary: List Currencies - * description: Retrieve a list of currencies. The currencies can be filtered by - * fields such as `id`. The currencies can also be sorted or paginated. + * description: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts index a85236e6b8..76588f4809 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/currencies/{code} * operationId: GetCurrenciesCode * summary: Get a Currency - * description: Retrieve a currency by its ID. You can expand the currency's - * relations or select the fields that should be returned. + * description: Retrieve a currency by its ID. You can expand the currency's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: code @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts index 9e30b30d94..627b356c59 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/customer-groups * operationId: GetCustomerGroups * summary: List Customer Groups - * description: Retrieve a list of customer groups. The customer groups can be - * filtered by fields such as `id`. The customer groups can also be sorted or - * paginated. + * description: Retrieve a list of customer groups. The customer groups can be filtered by fields such as `id`. The customer groups can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts index a2e024f20a..544273c0bb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/customer-groups/{id} * operationId: GetCustomerGroupsId * summary: Get a Customer Group - * description: Retrieve a customer group by its ID. You can expand the customer - * group's relations or select the fields that should be returned. + * description: Retrieve a customer group by its ID. You can expand the customer group's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts index 1ede1fce84..6d940a3029 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/customers * operationId: GetCustomers * summary: List Customers - * description: Retrieve a list of customers. The customers can be filtered by - * fields such as `id`. The customers can also be sorted or paginated. + * description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts index 1c017d9e99..ce4e951979 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/customers/{id} * operationId: GetCustomersId * summary: Get a Customer - * description: Retrieve a customer by its ID. You can expand the customer's - * relations or select the fields that should be returned. + * description: Retrieve a customer by its ID. You can expand the customer's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index cbf44e21ff..8dcdb5059e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/customers/{id}/addresses * operationId: GetCustomersIdAddresses * summary: List Addresses - * description: Retrieve a list of addresses in a customer. The addresses can be - * filtered by fields like FILTER FIELDS. The addresses can also be paginated. + * description: Retrieve a list of addresses in a customer. The addresses can be filtered by fields like FILTER FIELDS. The addresses can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts index ba86b223eb..6481c325ba 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/customers/{id}/addresses/{address_id} * operationId: GetCustomersIdAddressesAddress_id * summary: List Addresses - * description: Retrieve a list of addresses in a customer. The addresses can be - * filtered by fields like FILTER FIELDS. The addresses can also be paginated. + * description: Retrieve a list of addresses in a customer. The addresses can be filtered by fields like FILTER FIELDS. The addresses can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -28,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts index c6e5ac91dc..174039f203 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/draft-orders * operationId: GetDraftOrders * summary: List Draft Orders - * description: Retrieve a list of draft orders. The draft orders can be filtered - * by fields such as `id`. The draft orders can also be sorted or paginated. + * description: Retrieve a list of draft orders. The draft orders can be filtered by fields such as `id`. The draft orders can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts index 8b5fe8a79c..b460e7c77e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/draft-orders/{id} * operationId: GetDraftOrdersId * summary: Get a Draft Order - * description: Retrieve a draft order by its ID. You can expand the draft order's - * relations or select the fields that should be returned. + * description: Retrieve a draft order by its ID. You can expand the draft order's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -12,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts index c50bfdce09..6b7f2b0a9a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/exchanges * operationId: GetExchanges * summary: List Exchanges - * description: Retrieve a list of exchanges. The exchanges can be filtered by - * fields such as `id`. The exchanges can also be sorted or paginated. + * description: Retrieve a list of exchanges. The exchanges can be filtered by fields such as `id`. The exchanges can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts index 2b77dbfce2..60d277d7e9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/exchanges/{id} * operationId: GetExchangesId * summary: Get a Exchange - * description: Retrieve a exchange by its ID. You can expand the exchange's - * relations or select the fields that should be returned. + * description: Retrieve a exchange by its ID. You can expand the exchange's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts index ae74c3fdbb..8e0cfded21 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/fulfillment-providers * operationId: GetFulfillmentProviders * summary: List Fulfillment Providers - * description: Retrieve a list of fulfillment providers. The fulfillment providers - * can be filtered by fields such as `id`. The fulfillment providers can also be - * sorted or paginated. + * description: Retrieve a list of fulfillment providers. The fulfillment providers can be filtered by fields such as `id`. The fulfillment providers can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 @@ -74,7 +64,7 @@ * - name: is_enabled * in: query * description: The fulfillment provider's is enabled. - * required: true + * required: false * schema: * type: boolean * title: is_enabled diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index c62a6a7c96..ec7f81b4e0 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -2,9 +2,7 @@ * @oas [get] /admin/fulfillment-sets/{id}/service-zones/{zone_id} * operationId: GetFulfillmentSetsIdServiceZonesZone_id * summary: List Service Zones - * description: Retrieve a list of service zones in a fulfillment set. The service - * zones can be filtered by fields like FILTER FIELDS. The service zones can also - * be paginated. + * description: Retrieve a list of service zones in a fulfillment set. The service zones can be filtered by fields like FILTER FIELDS. The service zones can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -29,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -59,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] 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 253c229e96..a12d23074e 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 @@ -2,9 +2,7 @@ * @oas [get] /admin/inventory-items * operationId: GetInventoryItems * summary: List Inventory Items - * description: Retrieve a list of inventory items. The inventory items can be - * filtered by fields such as `id`. The inventory items can also be sorted or - * paginated. + * description: Retrieve a list of inventory items. The inventory items can be filtered by fields such as `id`. The inventory items can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 inventory item's q. @@ -152,7 +142,7 @@ * - name: requires_shipping * in: query * description: The inventory item's requires shipping. - * required: true + * required: false * schema: * type: boolean * title: requires_shipping diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts index fbddf8654b..9e2ca85b7c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/inventory-items/{id} * operationId: GetInventoryItemsId * summary: Get a Inventory Item - * description: Retrieve a inventory item by its ID. You can expand the inventory - * item's relations or select the fields that should be returned. + * description: Retrieve a inventory item by its ID. You can expand the inventory item's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts index d7a61c4b26..79c21777ad 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/inventory-items/{id}/location-levels * operationId: GetInventoryItemsIdLocationLevels * summary: List Location Levels - * description: Retrieve a list of location levels in a inventory item. The - * location levels can be filtered by fields like FILTER FIELDS. The location - * levels can also be paginated. + * description: Retrieve a list of location levels in a inventory item. The location levels can be filtered by fields like FILTER FIELDS. The location levels can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -23,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -53,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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: location_id * in: query * required: false 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 a7c2974349..b32af7bd00 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 @@ -2,8 +2,7 @@ * @oas [get] /admin/invites * operationId: GetInvites * summary: List Invites - * description: Retrieve a list of invites. The invites can be filtered by fields - * such as `id`. The invites can also be sorted or paginated. + * description: Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. @@ -98,104 +89,17 @@ * in: query * description: The invite's created at. * required: false - * schema: - * type: string - * description: The invite's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The invite's updated at. * required: false - * schema: - * type: string - * description: The invite's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The invite's deleted at. * required: false - * schema: - * type: string - * description: The invite's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false 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 89a8a243be..716b674739 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 @@ -2,8 +2,7 @@ * @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. + * description: Retrieve a 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 @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 c22d22d136..77447eeeab 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 @@ -2,8 +2,7 @@ * @oas [get] /admin/notifications * operationId: GetNotifications * summary: List Notifications - * description: Retrieve a list of notifications. The notifications can be filtered - * by fields such as `id`. The notifications can also be sorted or paginated. + * description: Retrieve a list of notifications. The notifications can be filtered by fields such as `id`. The notifications can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts index edf01c5058..28f8a2709e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/notifications/{id} * operationId: GetNotificationsId * summary: Get a Notification - * description: Retrieve a notification by its ID. You can expand the - * notification's relations or select the fields that should be returned. + * description: Retrieve a notification by its ID. You can expand the notification's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] 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 ac26077642..bb0decd97a 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 @@ -2,8 +2,7 @@ * @oas [get] /admin/orders * operationId: GetOrders * summary: List Orders - * description: Retrieve a list of orders. The orders can be filtered by fields - * such as `id`. The orders can also be sorted or paginated. + * description: Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -116,6 +107,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: getOrdersListWorkflow * */ 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 86136c31c1..0e1aa1fe98 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 @@ -2,8 +2,7 @@ * @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. + * description: Retrieve a 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 @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -93,6 +84,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: getOrderDetailWorkflow * */ 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 new file mode 100644 index 0000000000..c30d8e49cd --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts @@ -0,0 +1,93 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: |- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: |- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * 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 `-`. + * required: false + * schema: + * 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 `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/orders/{id}/changes' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderChangesResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + 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 0e5cc2c118..efb47b19f0 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 @@ -2,8 +2,7 @@ * @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. + * 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. * x-authenticated: true * parameters: * - name: id @@ -12,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] 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 3601928815..c75bb4b493 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 @@ -2,8 +2,7 @@ * @oas [get] /admin/payments * operationId: GetPayments * 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. + * description: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. @@ -96,104 +87,17 @@ * in: query * description: The payment's created at. * required: false - * schema: - * type: string - * description: The payment's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The payment's updated at. * required: false - * schema: - * type: string - * description: The payment's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The payment's deleted at. * required: false - * schema: - * type: string - * description: The payment's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts index 6e84968918..e1d0a55ebb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/payments/{id} * operationId: GetPaymentsId * summary: Get a Payment - * description: Retrieve a payment by its ID. You can expand the payment's - * relations or select the fields that should be returned. + * description: Retrieve a payment by its ID. You can expand the payment's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] 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 aed86f7031..b92f467ad7 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 @@ -2,8 +2,7 @@ * @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. + * description: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 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 567cc02e12..577be9ce9f 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 @@ -2,8 +2,7 @@ * @oas [get] /admin/price-lists * operationId: GetPriceLists * summary: List Price Lists - * description: Retrieve a list of price lists. The price lists can be filtered by - * fields such as `id`. The price lists can also be sorted or paginated. + * description: Retrieve a list of price lists. The price lists can be filtered by fields such as `id`. The price lists can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts index 9db000413f..9a972a84c9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/price-lists/{id} * operationId: GetPriceListsId * summary: Get a Price List - * description: Retrieve a price list by its ID. You can expand the price list's - * relations or select the fields that should be returned. + * description: Retrieve a price list by its ID. You can expand the price list's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * 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 e11e46729d..b0610fdca7 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 @@ -2,9 +2,7 @@ * @oas [get] /admin/price-preferences * operationId: GetPricePreferences * summary: List Price Preferences - * description: Retrieve a list of price preferences. The price preferences can be - * filtered by fields such as `id`. The price preferences can also be sorted or - * paginated. + * description: Retrieve a list of price preferences. The price preferences can be filtered by fields such as `id`. The price preferences can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts index 0136f50e15..bd875a9f99 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/price-preferences/{id} * operationId: GetPricePreferencesId * summary: Get a Price Preference - * description: Retrieve a price preference by its ID. You can expand the price - * preference's relations or select the fields that should be returned. + * description: Retrieve a price preference by its ID. You can expand the price preference's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * 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 d180f84a4b..913d55b643 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 @@ -2,9 +2,7 @@ * @oas [get] /admin/product-categories * operationId: GetProductCategories * summary: List Product Categories - * description: Retrieve a list of product categories. The product categories can - * be filtered by fields such as `id`. The product categories can also be sorted - * or paginated. + * description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. @@ -124,7 +114,7 @@ * - name: include_ancestors_tree * in: query * description: The product category's include ancestors tree. - * required: true + * required: false * schema: * type: boolean * title: include_ancestors_tree @@ -132,7 +122,7 @@ * - name: include_descendants_tree * in: query * description: The product category's include descendants tree. - * required: true + * required: false * schema: * type: boolean * title: include_descendants_tree @@ -140,7 +130,7 @@ * - name: is_internal * in: query * description: The product category's is internal. - * required: true + * required: false * schema: * type: boolean * title: is_internal @@ -148,7 +138,7 @@ * - name: is_active * in: query * description: The product category's is active. - * required: true + * required: false * schema: * type: boolean * title: is_active @@ -157,104 +147,17 @@ * in: query * description: The product category's created at. * required: false - * schema: - * type: string - * description: The product category's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The product category's updated at. * required: false - * schema: - * type: string - * description: The product category's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The product category's deleted at. * required: false - * schema: - * type: string - * description: The product category's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false 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 f83a9ae996..459a4d33e4 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 @@ -2,8 +2,7 @@ * @oas [get] /admin/product-categories/{id} * operationId: GetProductCategoriesId * summary: Get a Product Category - * description: Retrieve a product category by its ID. You can expand the product - * category's relations or select the fields that should be returned. + * description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,20 +47,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. - * required: true + * required: false * schema: * type: boolean * title: include_ancestors_tree @@ -73,7 +64,7 @@ * - name: include_descendants_tree * in: query * description: The product category's include descendants tree. - * required: true + * required: false * schema: * type: boolean * title: include_descendants_tree 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 b8519b86e1..8d8fe0ce54 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 @@ -2,8 +2,7 @@ * @oas [get] /admin/product-tags * operationId: GetProductTags * summary: List Product Tags - * description: Retrieve a list of product tags. The product tags can be filtered - * by fields such as `id`. The product tags can also be sorted or paginated. + * description: Retrieve a list of product tags. The product tags can be filtered by fields such as `id`. The product tags can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. @@ -96,104 +87,17 @@ * in: query * description: The product tag's created at. * required: false - * schema: - * type: string - * description: The product tag's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The product tag's updated at. * required: false - * schema: - * type: string - * description: The product tag's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The product tag's deleted at. * required: false - * schema: - * type: string - * description: The product tag's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts index f63ba8dd6a..bcfb1ac0dc 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/product-tags/{id} * operationId: GetProductTagsId * summary: Get a Product Tag - * description: Retrieve a product tag by its ID. You can expand the product tag's - * relations or select the fields that should be returned. + * description: Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] 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 02b7bdf2ad..46ec0a3c2c 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 @@ -2,8 +2,7 @@ * @oas [get] /admin/product-types * operationId: GetProductTypes * summary: List Product Types - * description: Retrieve a list of product types. The product types can be filtered - * by fields such as `id`. The product types can also be sorted or paginated. + * description: Retrieve a list of product types. The product types can be filtered by fields such as `id`. The product types can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. @@ -96,104 +87,17 @@ * in: query * description: The product type's created at. * required: false - * schema: - * type: string - * description: The product type's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The product type's updated at. * required: false - * schema: - * type: string - * description: The product type's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The product type's deleted at. * required: false - * schema: - * type: string - * description: The product type's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts index 5c11db722b..2e19f7099a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/product-types/{id} * operationId: GetProductTypesId * summary: Get a Product Type - * description: Retrieve a product type by its ID. You can expand the product - * type's relations or select the fields that should be returned. + * description: Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] 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 8970c04a0b..e2c3da1c2b 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 @@ -2,9 +2,7 @@ * @oas [get] /admin/product-variants * operationId: GetProductVariants * summary: List Product Variants - * description: Retrieve a list of product variants. The product variants can be - * filtered by fields such as `id`. The product variants can also be sorted or - * paginated. + * description: Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts index 3621f66c9b..382d68867a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/products * operationId: GetProducts * summary: List Products - * description: Retrieve a list of products. The products can be filtered by fields - * such as `id`. The products can also be sorted or paginated. + * description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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: price_list_id * in: query * required: false @@ -4413,1867 +4404,175 @@ * type: array * description: The created at's $and. * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1128: - * type: object - * description: The $and's @match@1128. - * __@replace@1130: - * type: object - * description: The $and's @replace@1130. - * __@search@1133: - * type: object - * description: The $and's @search@1133. - * __@split@1135: - * type: object - * description: The $and's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $and's @matchall@1137. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $and's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $and's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $and's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * - type: object - * description: The $and's $not. - * - type: array - * description: The $and's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $and's $like. - * $re: - * type: string - * title: $re - * description: The $and's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $and's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $and's $fulltext. - * $overlap: - * type: array - * description: The $and's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $and's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $and's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $and's $exists. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1128: - * type: object - * description: The $and's @match@1128. - * __@replace@1130: - * type: object - * description: The $and's @replace@1130. - * __@search@1133: - * type: object - * description: The $and's @search@1133. - * __@split@1135: - * type: object - * description: The $and's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $and's @matchall@1137. + * type: object * $or: * type: array * description: The created at's $or. * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1128: - * type: object - * description: The $or's @match@1128. - * __@replace@1130: - * type: object - * description: The $or's @replace@1130. - * __@search@1133: - * type: object - * description: The $or's @search@1133. - * __@split@1135: - * type: object - * description: The $or's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $or's @matchall@1137. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $or's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $or's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $or's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * - type: object - * description: The $or's $not. - * - type: array - * description: The $or's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $or's $like. - * $re: - * type: string - * title: $re - * description: The $or's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $or's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $or's $fulltext. - * $overlap: - * type: array - * description: The $or's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $or's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $or's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $or's $exists. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1128: - * type: object - * description: The $or's @match@1128. - * __@replace@1130: - * type: object - * description: The $or's @replace@1130. - * __@search@1133: - * type: object - * description: The $or's @search@1133. - * __@split@1135: - * type: object - * description: The $or's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $or's @matchall@1137. + * type: object * $eq: * oneOf: * - type: string * title: $eq - * description: The created at's $eq. - * - type: object - * description: The created at's $eq. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1128: - * type: object - * description: The $eq's @match@1128. - * __@replace@1130: - * type: object - * description: The $eq's @replace@1130. - * __@search@1133: - * type: object - * description: The $eq's @search@1133. - * __@split@1135: - * type: object - * description: The $eq's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $eq's @matchall@1137. + * description: Filter by an exact match. * - type: array - * description: The created at's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1128: - * type: object - * description: The $eq's @match@1128. - * __@replace@1130: - * type: object - * description: The $eq's @replace@1130. - * __@search@1133: - * type: object - * description: The $eq's @search@1133. - * __@split@1135: - * type: object - * description: The $eq's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $eq's @matchall@1137. + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The created at's $ne. - * - type: object - * description: The created at's $ne. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * test: - * type: object - * description: The $ne's test. - * source: - * type: string - * title: source - * description: The $ne's source. - * global: - * type: boolean - * title: global - * description: The $ne's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $ne's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $ne's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $ne's lastindex. - * compile: - * type: object - * description: The $ne's compile. - * flags: - * type: string - * title: flags - * description: The $ne's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $ne's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $ne's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $ne's dotall. - * __@match@1128: - * type: object - * description: The $ne's @match@1128. - * __@replace@1130: - * type: object - * description: The $ne's @replace@1130. - * __@search@1133: - * type: object - * description: The $ne's @search@1133. - * __@split@1135: - * type: object - * description: The $ne's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $ne's @matchall@1137. + * type: string + * title: $ne * $in: * type: array * description: The created at's $in. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $in's exec. - * test: - * type: object - * description: The $in's test. - * source: - * type: string - * title: source - * description: The $in's source. - * global: - * type: boolean - * title: global - * description: The $in's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $in's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $in's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $in's lastindex. - * compile: - * type: object - * description: The $in's compile. - * flags: - * type: string - * title: flags - * description: The $in's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $in's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $in's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $in's dotall. - * __@match@1128: - * type: object - * description: The $in's @match@1128. - * __@replace@1130: - * type: object - * description: The $in's @replace@1130. - * __@search@1133: - * type: object - * description: The $in's @search@1133. - * __@split@1135: - * type: object - * description: The $in's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $in's @matchall@1137. + * type: string + * title: $in * $nin: * type: array * description: The created at's $nin. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * test: - * type: object - * description: The $nin's test. - * source: - * type: string - * title: source - * description: The $nin's source. - * global: - * type: boolean - * title: global - * description: The $nin's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $nin's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $nin's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $nin's lastindex. - * compile: - * type: object - * description: The $nin's compile. - * flags: - * type: string - * title: flags - * description: The $nin's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $nin's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $nin's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $nin's dotall. - * __@match@1128: - * type: object - * description: The $nin's @match@1128. - * __@replace@1130: - * type: object - * description: The $nin's @replace@1130. - * __@search@1133: - * type: object - * description: The $nin's @search@1133. - * __@split@1135: - * type: object - * description: The $nin's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $nin's @matchall@1137. + * type: string + * title: $nin * $not: * oneOf: * - type: string * title: $not - * description: The created at's $not. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The created at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1128: - * type: object - * description: The $not's @match@1128. - * __@replace@1130: - * type: object - * description: The $not's @replace@1130. - * __@search@1133: - * type: object - * description: The $not's @search@1133. - * __@split@1135: - * type: object - * description: The $not's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $not's @matchall@1137. - * - type: object - * description: The created at's $not. + * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array * description: The $not's $and. * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp + * type: object + * title: $and * $or: * type: array * description: The $not's $or. * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp + * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp + * description: Filter by an exact match. * - type: array - * description: The $not's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The $not's $in. + * description: Filter by values in this array. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp + * type: string + * title: $in + * description: Filter by values in this array. * $nin: * type: array - * description: The $not's $nin. + * description: Filter by values not in this array. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp + * type: string + * title: $nin + * description: Filter by values not in this array. * $not: * oneOf: * - type: string * title: $not - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * - type: object - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp + * 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: The $not's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The $not's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The $not's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The $not's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The $not's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: Filter arrays that have overlapping values with this parameter. * $contains: * type: array - * description: The $not's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: Filter arrays that contain some of the values of this parameter. * $contained: * type: array - * description: The $not's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: Filter arrays that contain all values of this parameter. * $exists: * type: boolean * title: $exists - * description: The $not's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: The created at's $not. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1128: - * type: object - * description: The $not's @match@1128. - * __@replace@1130: - * type: object - * description: The $not's @replace@1130. - * __@search@1133: - * type: object - * description: The $not's @search@1133. - * __@split@1135: - * type: object - * description: The $not's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $not's @matchall@1137. + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The created at's $gt. - * - type: object - * description: The created at's $gt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * test: - * type: object - * description: The $gt's test. - * source: - * type: string - * title: source - * description: The $gt's source. - * global: - * type: boolean - * title: global - * description: The $gt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gt's lastindex. - * compile: - * type: object - * description: The $gt's compile. - * flags: - * type: string - * title: flags - * description: The $gt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gt's dotall. - * __@match@1128: - * type: object - * description: The $gt's @match@1128. - * __@replace@1130: - * type: object - * description: The $gt's @replace@1130. - * __@search@1133: - * type: object - * description: The $gt's @search@1133. - * __@split@1135: - * type: object - * description: The $gt's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $gt's @matchall@1137. + * type: string + * title: $gt * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The created at's $gte. - * - type: object - * description: The created at's $gte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * test: - * type: object - * description: The $gte's test. - * source: - * type: string - * title: source - * description: The $gte's source. - * global: - * type: boolean - * title: global - * description: The $gte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gte's lastindex. - * compile: - * type: object - * description: The $gte's compile. - * flags: - * type: string - * title: flags - * description: The $gte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gte's dotall. - * __@match@1128: - * type: object - * description: The $gte's @match@1128. - * __@replace@1130: - * type: object - * description: The $gte's @replace@1130. - * __@search@1133: - * type: object - * description: The $gte's @search@1133. - * __@split@1135: - * type: object - * description: The $gte's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $gte's @matchall@1137. + * type: string + * title: $gte * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The created at's $lt. - * - type: object - * description: The created at's $lt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * test: - * type: object - * description: The $lt's test. - * source: - * type: string - * title: source - * description: The $lt's source. - * global: - * type: boolean - * title: global - * description: The $lt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lt's lastindex. - * compile: - * type: object - * description: The $lt's compile. - * flags: - * type: string - * title: flags - * description: The $lt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lt's dotall. - * __@match@1128: - * type: object - * description: The $lt's @match@1128. - * __@replace@1130: - * type: object - * description: The $lt's @replace@1130. - * __@search@1133: - * type: object - * description: The $lt's @search@1133. - * __@split@1135: - * type: object - * description: The $lt's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $lt's @matchall@1137. + * type: string + * title: $lt * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The created at's $lte. - * - type: object - * description: The created at's $lte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * test: - * type: object - * description: The $lte's test. - * source: - * type: string - * title: source - * description: The $lte's source. - * global: - * type: boolean - * title: global - * description: The $lte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lte's lastindex. - * compile: - * type: object - * description: The $lte's compile. - * flags: - * type: string - * title: flags - * description: The $lte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lte's dotall. - * __@match@1128: - * type: object - * description: The $lte's @match@1128. - * __@replace@1130: - * type: object - * description: The $lte's @replace@1130. - * __@search@1133: - * type: object - * description: The $lte's @search@1133. - * __@split@1135: - * type: object - * description: The $lte's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $lte's @matchall@1137. + * type: string + * title: $lte * $like: * type: string * title: $like @@ -6327,1867 +4626,175 @@ * type: array * description: The updated at's $and. * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1128: - * type: object - * description: The $and's @match@1128. - * __@replace@1130: - * type: object - * description: The $and's @replace@1130. - * __@search@1133: - * type: object - * description: The $and's @search@1133. - * __@split@1135: - * type: object - * description: The $and's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $and's @matchall@1137. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $and's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $and's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $and's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * - type: object - * description: The $and's $not. - * - type: array - * description: The $and's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $and's $like. - * $re: - * type: string - * title: $re - * description: The $and's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $and's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $and's $fulltext. - * $overlap: - * type: array - * description: The $and's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $and's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $and's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $and's $exists. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1128: - * type: object - * description: The $and's @match@1128. - * __@replace@1130: - * type: object - * description: The $and's @replace@1130. - * __@search@1133: - * type: object - * description: The $and's @search@1133. - * __@split@1135: - * type: object - * description: The $and's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $and's @matchall@1137. + * type: object * $or: * type: array * description: The updated at's $or. * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1128: - * type: object - * description: The $or's @match@1128. - * __@replace@1130: - * type: object - * description: The $or's @replace@1130. - * __@search@1133: - * type: object - * description: The $or's @search@1133. - * __@split@1135: - * type: object - * description: The $or's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $or's @matchall@1137. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $or's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $or's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $or's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * - type: object - * description: The $or's $not. - * - type: array - * description: The $or's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $or's $like. - * $re: - * type: string - * title: $re - * description: The $or's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $or's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $or's $fulltext. - * $overlap: - * type: array - * description: The $or's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $or's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $or's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $or's $exists. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1128: - * type: object - * description: The $or's @match@1128. - * __@replace@1130: - * type: object - * description: The $or's @replace@1130. - * __@search@1133: - * type: object - * description: The $or's @search@1133. - * __@split@1135: - * type: object - * description: The $or's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $or's @matchall@1137. + * type: object * $eq: * oneOf: * - type: string * title: $eq - * description: The updated at's $eq. - * - type: object - * description: The updated at's $eq. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1128: - * type: object - * description: The $eq's @match@1128. - * __@replace@1130: - * type: object - * description: The $eq's @replace@1130. - * __@search@1133: - * type: object - * description: The $eq's @search@1133. - * __@split@1135: - * type: object - * description: The $eq's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $eq's @matchall@1137. + * description: Filter by an exact match. * - type: array - * description: The updated at's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1128: - * type: object - * description: The $eq's @match@1128. - * __@replace@1130: - * type: object - * description: The $eq's @replace@1130. - * __@search@1133: - * type: object - * description: The $eq's @search@1133. - * __@split@1135: - * type: object - * description: The $eq's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $eq's @matchall@1137. + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The updated at's $ne. - * - type: object - * description: The updated at's $ne. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * test: - * type: object - * description: The $ne's test. - * source: - * type: string - * title: source - * description: The $ne's source. - * global: - * type: boolean - * title: global - * description: The $ne's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $ne's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $ne's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $ne's lastindex. - * compile: - * type: object - * description: The $ne's compile. - * flags: - * type: string - * title: flags - * description: The $ne's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $ne's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $ne's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $ne's dotall. - * __@match@1128: - * type: object - * description: The $ne's @match@1128. - * __@replace@1130: - * type: object - * description: The $ne's @replace@1130. - * __@search@1133: - * type: object - * description: The $ne's @search@1133. - * __@split@1135: - * type: object - * description: The $ne's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $ne's @matchall@1137. + * type: string + * title: $ne * $in: * type: array * description: The updated at's $in. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $in's exec. - * test: - * type: object - * description: The $in's test. - * source: - * type: string - * title: source - * description: The $in's source. - * global: - * type: boolean - * title: global - * description: The $in's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $in's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $in's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $in's lastindex. - * compile: - * type: object - * description: The $in's compile. - * flags: - * type: string - * title: flags - * description: The $in's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $in's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $in's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $in's dotall. - * __@match@1128: - * type: object - * description: The $in's @match@1128. - * __@replace@1130: - * type: object - * description: The $in's @replace@1130. - * __@search@1133: - * type: object - * description: The $in's @search@1133. - * __@split@1135: - * type: object - * description: The $in's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $in's @matchall@1137. + * type: string + * title: $in * $nin: * type: array * description: The updated at's $nin. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * test: - * type: object - * description: The $nin's test. - * source: - * type: string - * title: source - * description: The $nin's source. - * global: - * type: boolean - * title: global - * description: The $nin's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $nin's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $nin's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $nin's lastindex. - * compile: - * type: object - * description: The $nin's compile. - * flags: - * type: string - * title: flags - * description: The $nin's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $nin's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $nin's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $nin's dotall. - * __@match@1128: - * type: object - * description: The $nin's @match@1128. - * __@replace@1130: - * type: object - * description: The $nin's @replace@1130. - * __@search@1133: - * type: object - * description: The $nin's @search@1133. - * __@split@1135: - * type: object - * description: The $nin's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $nin's @matchall@1137. + * type: string + * title: $nin * $not: * oneOf: * - type: string * title: $not - * description: The updated at's $not. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The updated at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1128: - * type: object - * description: The $not's @match@1128. - * __@replace@1130: - * type: object - * description: The $not's @replace@1130. - * __@search@1133: - * type: object - * description: The $not's @search@1133. - * __@split@1135: - * type: object - * description: The $not's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $not's @matchall@1137. - * - type: object - * description: The updated at's $not. + * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array * description: The $not's $and. * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp + * type: object + * title: $and * $or: * type: array * description: The $not's $or. * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp + * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp + * description: Filter by an exact match. * - type: array - * description: The $not's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The $not's $in. + * description: Filter by values in this array. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp + * type: string + * title: $in + * description: Filter by values in this array. * $nin: * type: array - * description: The $not's $nin. + * description: Filter by values not in this array. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp + * type: string + * title: $nin + * description: Filter by values not in this array. * $not: * oneOf: * - type: string * title: $not - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * - type: object - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp + * 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: The $not's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The $not's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The $not's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The $not's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The $not's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: Filter arrays that have overlapping values with this parameter. * $contains: * type: array - * description: The $not's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: Filter arrays that contain some of the values of this parameter. * $contained: * type: array - * description: The $not's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: Filter arrays that contain all values of this parameter. * $exists: * type: boolean * title: $exists - * description: The $not's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: The updated at's $not. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1128: - * type: object - * description: The $not's @match@1128. - * __@replace@1130: - * type: object - * description: The $not's @replace@1130. - * __@search@1133: - * type: object - * description: The $not's @search@1133. - * __@split@1135: - * type: object - * description: The $not's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $not's @matchall@1137. + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The updated at's $gt. - * - type: object - * description: The updated at's $gt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * test: - * type: object - * description: The $gt's test. - * source: - * type: string - * title: source - * description: The $gt's source. - * global: - * type: boolean - * title: global - * description: The $gt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gt's lastindex. - * compile: - * type: object - * description: The $gt's compile. - * flags: - * type: string - * title: flags - * description: The $gt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gt's dotall. - * __@match@1128: - * type: object - * description: The $gt's @match@1128. - * __@replace@1130: - * type: object - * description: The $gt's @replace@1130. - * __@search@1133: - * type: object - * description: The $gt's @search@1133. - * __@split@1135: - * type: object - * description: The $gt's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $gt's @matchall@1137. + * type: string + * title: $gt * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The updated at's $gte. - * - type: object - * description: The updated at's $gte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * test: - * type: object - * description: The $gte's test. - * source: - * type: string - * title: source - * description: The $gte's source. - * global: - * type: boolean - * title: global - * description: The $gte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gte's lastindex. - * compile: - * type: object - * description: The $gte's compile. - * flags: - * type: string - * title: flags - * description: The $gte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gte's dotall. - * __@match@1128: - * type: object - * description: The $gte's @match@1128. - * __@replace@1130: - * type: object - * description: The $gte's @replace@1130. - * __@search@1133: - * type: object - * description: The $gte's @search@1133. - * __@split@1135: - * type: object - * description: The $gte's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $gte's @matchall@1137. + * type: string + * title: $gte * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The updated at's $lt. - * - type: object - * description: The updated at's $lt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * test: - * type: object - * description: The $lt's test. - * source: - * type: string - * title: source - * description: The $lt's source. - * global: - * type: boolean - * title: global - * description: The $lt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lt's lastindex. - * compile: - * type: object - * description: The $lt's compile. - * flags: - * type: string - * title: flags - * description: The $lt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lt's dotall. - * __@match@1128: - * type: object - * description: The $lt's @match@1128. - * __@replace@1130: - * type: object - * description: The $lt's @replace@1130. - * __@search@1133: - * type: object - * description: The $lt's @search@1133. - * __@split@1135: - * type: object - * description: The $lt's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $lt's @matchall@1137. + * type: string + * title: $lt * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The updated at's $lte. - * - type: object - * description: The updated at's $lte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * test: - * type: object - * description: The $lte's test. - * source: - * type: string - * title: source - * description: The $lte's source. - * global: - * type: boolean - * title: global - * description: The $lte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lte's lastindex. - * compile: - * type: object - * description: The $lte's compile. - * flags: - * type: string - * title: flags - * description: The $lte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lte's dotall. - * __@match@1128: - * type: object - * description: The $lte's @match@1128. - * __@replace@1130: - * type: object - * description: The $lte's @replace@1130. - * __@search@1133: - * type: object - * description: The $lte's @search@1133. - * __@split@1135: - * type: object - * description: The $lte's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $lte's @matchall@1137. + * type: string + * title: $lte * $like: * type: string * title: $like @@ -8241,1867 +4848,175 @@ * type: array * description: The deleted at's $and. * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1128: - * type: object - * description: The $and's @match@1128. - * __@replace@1130: - * type: object - * description: The $and's @replace@1130. - * __@search@1133: - * type: object - * description: The $and's @search@1133. - * __@split@1135: - * type: object - * description: The $and's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $and's @matchall@1137. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $and's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $and's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $and's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * - type: object - * description: The $and's $not. - * - type: array - * description: The $and's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $and's $like. - * $re: - * type: string - * title: $re - * description: The $and's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $and's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $and's $fulltext. - * $overlap: - * type: array - * description: The $and's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $and's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $and's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $and's $exists. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1128: - * type: object - * description: The $and's @match@1128. - * __@replace@1130: - * type: object - * description: The $and's @replace@1130. - * __@search@1133: - * type: object - * description: The $and's @search@1133. - * __@split@1135: - * type: object - * description: The $and's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $and's @matchall@1137. + * type: object * $or: * type: array * description: The deleted at's $or. * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1128: - * type: object - * description: The $or's @match@1128. - * __@replace@1130: - * type: object - * description: The $or's @replace@1130. - * __@search@1133: - * type: object - * description: The $or's @search@1133. - * __@split@1135: - * type: object - * description: The $or's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $or's @matchall@1137. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $or's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $or's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $or's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * - type: object - * description: The $or's $not. - * - type: array - * description: The $or's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $or's $like. - * $re: - * type: string - * title: $re - * description: The $or's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $or's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $or's $fulltext. - * $overlap: - * type: array - * description: The $or's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $or's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $or's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $or's $exists. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1128: - * type: object - * description: The $or's @match@1128. - * __@replace@1130: - * type: object - * description: The $or's @replace@1130. - * __@search@1133: - * type: object - * description: The $or's @search@1133. - * __@split@1135: - * type: object - * description: The $or's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $or's @matchall@1137. + * type: object * $eq: * oneOf: * - type: string * title: $eq - * description: The deleted at's $eq. - * - type: object - * description: The deleted at's $eq. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1128: - * type: object - * description: The $eq's @match@1128. - * __@replace@1130: - * type: object - * description: The $eq's @replace@1130. - * __@search@1133: - * type: object - * description: The $eq's @search@1133. - * __@split@1135: - * type: object - * description: The $eq's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $eq's @matchall@1137. + * description: Filter by an exact match. * - type: array - * description: The deleted at's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1128: - * type: object - * description: The $eq's @match@1128. - * __@replace@1130: - * type: object - * description: The $eq's @replace@1130. - * __@search@1133: - * type: object - * description: The $eq's @search@1133. - * __@split@1135: - * type: object - * description: The $eq's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $eq's @matchall@1137. + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The deleted at's $ne. - * - type: object - * description: The deleted at's $ne. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * test: - * type: object - * description: The $ne's test. - * source: - * type: string - * title: source - * description: The $ne's source. - * global: - * type: boolean - * title: global - * description: The $ne's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $ne's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $ne's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $ne's lastindex. - * compile: - * type: object - * description: The $ne's compile. - * flags: - * type: string - * title: flags - * description: The $ne's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $ne's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $ne's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $ne's dotall. - * __@match@1128: - * type: object - * description: The $ne's @match@1128. - * __@replace@1130: - * type: object - * description: The $ne's @replace@1130. - * __@search@1133: - * type: object - * description: The $ne's @search@1133. - * __@split@1135: - * type: object - * description: The $ne's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $ne's @matchall@1137. + * type: string + * title: $ne * $in: * type: array * description: The deleted at's $in. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $in's exec. - * test: - * type: object - * description: The $in's test. - * source: - * type: string - * title: source - * description: The $in's source. - * global: - * type: boolean - * title: global - * description: The $in's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $in's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $in's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $in's lastindex. - * compile: - * type: object - * description: The $in's compile. - * flags: - * type: string - * title: flags - * description: The $in's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $in's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $in's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $in's dotall. - * __@match@1128: - * type: object - * description: The $in's @match@1128. - * __@replace@1130: - * type: object - * description: The $in's @replace@1130. - * __@search@1133: - * type: object - * description: The $in's @search@1133. - * __@split@1135: - * type: object - * description: The $in's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $in's @matchall@1137. + * type: string + * title: $in * $nin: * type: array * description: The deleted at's $nin. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * test: - * type: object - * description: The $nin's test. - * source: - * type: string - * title: source - * description: The $nin's source. - * global: - * type: boolean - * title: global - * description: The $nin's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $nin's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $nin's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $nin's lastindex. - * compile: - * type: object - * description: The $nin's compile. - * flags: - * type: string - * title: flags - * description: The $nin's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $nin's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $nin's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $nin's dotall. - * __@match@1128: - * type: object - * description: The $nin's @match@1128. - * __@replace@1130: - * type: object - * description: The $nin's @replace@1130. - * __@search@1133: - * type: object - * description: The $nin's @search@1133. - * __@split@1135: - * type: object - * description: The $nin's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $nin's @matchall@1137. + * type: string + * title: $nin * $not: * oneOf: * - type: string * title: $not - * description: The deleted at's $not. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The deleted at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1128: - * type: object - * description: The $not's @match@1128. - * __@replace@1130: - * type: object - * description: The $not's @replace@1130. - * __@search@1133: - * type: object - * description: The $not's @search@1133. - * __@split@1135: - * type: object - * description: The $not's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $not's @matchall@1137. - * - type: object - * description: The deleted at's $not. + * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array * description: The $not's $and. * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: string - * title: $and - * description: The $and's details. - * - type: object - * description: The $and's details. - * x-schemaName: RegExp + * type: object + * title: $and * $or: * type: array * description: The $not's $or. * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: string - * title: $or - * description: The $or's details. - * - type: object - * description: The $or's details. - * x-schemaName: RegExp + * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp + * description: Filter by an exact match. * - type: array - * description: The $not's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The $not's $in. + * description: Filter by values in this array. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp + * type: string + * title: $in + * description: Filter by values in this array. * $nin: * type: array - * description: The $not's $nin. + * description: Filter by values not in this array. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp + * type: string + * title: $nin + * description: Filter by values not in this array. * $not: * oneOf: * - type: string * title: $not - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * - type: object - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp + * 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: The $not's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The $not's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The $not's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The $not's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The $not's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: Filter arrays that have overlapping values with this parameter. * $contains: * type: array - * description: The $not's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: Filter arrays that contain some of the values of this parameter. * $contained: * type: array - * description: The $not's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: Filter arrays that contain all values of this parameter. * $exists: * type: boolean * title: $exists - * description: The $not's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: The deleted at's $not. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1128: - * type: object - * description: The $not's @match@1128. - * __@replace@1130: - * type: object - * description: The $not's @replace@1130. - * __@search@1133: - * type: object - * description: The $not's @search@1133. - * __@split@1135: - * type: object - * description: The $not's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $not's @matchall@1137. + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The deleted at's $gt. - * - type: object - * description: The deleted at's $gt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * test: - * type: object - * description: The $gt's test. - * source: - * type: string - * title: source - * description: The $gt's source. - * global: - * type: boolean - * title: global - * description: The $gt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gt's lastindex. - * compile: - * type: object - * description: The $gt's compile. - * flags: - * type: string - * title: flags - * description: The $gt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gt's dotall. - * __@match@1128: - * type: object - * description: The $gt's @match@1128. - * __@replace@1130: - * type: object - * description: The $gt's @replace@1130. - * __@search@1133: - * type: object - * description: The $gt's @search@1133. - * __@split@1135: - * type: object - * description: The $gt's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $gt's @matchall@1137. + * type: string + * title: $gt * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The deleted at's $gte. - * - type: object - * description: The deleted at's $gte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * test: - * type: object - * description: The $gte's test. - * source: - * type: string - * title: source - * description: The $gte's source. - * global: - * type: boolean - * title: global - * description: The $gte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gte's lastindex. - * compile: - * type: object - * description: The $gte's compile. - * flags: - * type: string - * title: flags - * description: The $gte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gte's dotall. - * __@match@1128: - * type: object - * description: The $gte's @match@1128. - * __@replace@1130: - * type: object - * description: The $gte's @replace@1130. - * __@search@1133: - * type: object - * description: The $gte's @search@1133. - * __@split@1135: - * type: object - * description: The $gte's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $gte's @matchall@1137. + * type: string + * title: $gte * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The deleted at's $lt. - * - type: object - * description: The deleted at's $lt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * test: - * type: object - * description: The $lt's test. - * source: - * type: string - * title: source - * description: The $lt's source. - * global: - * type: boolean - * title: global - * description: The $lt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lt's lastindex. - * compile: - * type: object - * description: The $lt's compile. - * flags: - * type: string - * title: flags - * description: The $lt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lt's dotall. - * __@match@1128: - * type: object - * description: The $lt's @match@1128. - * __@replace@1130: - * type: object - * description: The $lt's @replace@1130. - * __@search@1133: - * type: object - * description: The $lt's @search@1133. - * __@split@1135: - * type: object - * description: The $lt's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $lt's @matchall@1137. + * type: string + * title: $lt * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The deleted at's $lte. - * - type: object - * description: The deleted at's $lte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1128 - * - __@replace@1130 - * - __@search@1133 - * - __@matchAll@1137 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * test: - * type: object - * description: The $lte's test. - * source: - * type: string - * title: source - * description: The $lte's source. - * global: - * type: boolean - * title: global - * description: The $lte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lte's lastindex. - * compile: - * type: object - * description: The $lte's compile. - * flags: - * type: string - * title: flags - * description: The $lte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lte's dotall. - * __@match@1128: - * type: object - * description: The $lte's @match@1128. - * __@replace@1130: - * type: object - * description: The $lte's @replace@1130. - * __@search@1133: - * type: object - * description: The $lte's @search@1133. - * __@split@1135: - * type: object - * description: The $lte's @split@1135. - * __@matchAll@1137: - * type: object - * description: The $lte's @matchall@1137. + * type: string + * title: $lte * $like: * type: string * title: $like @@ -10151,10 +5066,8 @@ * type: array * description: The product's $and. * items: - * type: array - * items: - * type: object - * title: $and + * type: object + * title: $and * - name: $or * in: query * description: The product's $or. @@ -10163,10 +5076,8 @@ * type: array * description: The product's $or. * items: - * type: array - * items: - * type: object - * title: $or + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts index b4c6201264..1638c442a8 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/products/{id} * operationId: GetProductsId * summary: Get a Product - * description: Retrieve a product by its ID. You can expand the product's - * relations or select the fields that should be returned. + * description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts index 485338089e..a7f56bcad1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/products/{id}/options * operationId: GetProductsIdOptions * summary: List Options - * description: Retrieve a list of options in a product. The options can be - * filtered by fields like FILTER FIELDS. The options can also be paginated. + * description: Retrieve a list of options in a product. The options can be filtered by fields like FILTER FIELDS. The options can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The product's q. @@ -120,10 +111,8 @@ * type: array * description: The product's $and. * items: - * type: array - * items: - * type: object - * title: $and + * type: object + * title: $and * - name: $or * in: query * description: The product's $or. @@ -132,10 +121,8 @@ * type: array * description: The product's $or. * items: - * type: array - * items: - * type: object - * title: $or + * type: object + * title: $or * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts index 036115c2b5..a785d30ec1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/products/{id}/options/{option_id} * operationId: GetProductsIdOptionsOption_id * summary: List Options - * description: Retrieve a list of options in a product. The options can be - * filtered by fields like FILTER FIELDS. The options can also be paginated. + * description: Retrieve a list of options in a product. The options can be filtered by fields like FILTER FIELDS. The options can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -28,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts index bae2cb6e73..9f6d0f233b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/products/{id}/variants * operationId: GetProductsIdVariants * summary: List Variants - * description: Retrieve a list of variants in a product. The variants can be - * filtered by fields like FILTER FIELDS. The variants can also be paginated. + * description: Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts index 3c428c629b..a6d3ae3908 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/products/{id}/variants/{variant_id} * operationId: GetProductsIdVariantsVariant_id * summary: List Variants - * description: Retrieve a list of variants in a product. The variants can be - * filtered by fields like FILTER FIELDS. The variants can also be paginated. + * description: Retrieve a list of variants in a product. The variants can be filtered by fields like FILTER FIELDS. The variants can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -28,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts index 4ee7ec7d0c..7821cae75e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/promotions * operationId: GetPromotions * summary: List Promotions - * description: Retrieve a list of promotions. The promotions can be filtered by - * fields such as `id`. The promotions can also be sorted or paginated. + * description: Retrieve a list of promotions. The promotions can be filtered by fields such as `id`. The promotions can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The promotion's q. @@ -115,104 +106,17 @@ * in: query * description: The promotion's created at. * required: false - * schema: - * type: string - * description: The promotion's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The promotion's updated at. * required: false - * schema: - * type: string - * description: The promotion's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The promotion's deleted at. * required: false - * schema: - * type: string - * description: The promotion's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts index 4acbd9139b..70ffe7949d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/promotions/{id} * operationId: GetPromotionsId * summary: Get a Promotion - * description: Retrieve a promotion by its ID. You can expand the promotion's - * relations or select the fields that should be returned. + * description: Retrieve a promotion by its ID. You can expand the promotion's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts index 4b74d282c0..d4af243a1e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/promotions/{id}/{rule_type} * operationId: GetPromotionsIdRule_type * summary: "List " - * description: Retrieve a list of in a promotion. The can be filtered by fields - * like FILTER FIELDS. The can also be paginated. + * description: Retrieve a list of in a promotion. The can be filtered by fields like FILTER FIELDS. The can also be paginated. * x-authenticated: true * parameters: * - name: id @@ -28,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts index c4b9d19b4c..f8727f9d92 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts @@ -2,9 +2,7 @@ * @oas [get] /admin/promotions/rule-attribute-options/{rule_type} * operationId: GetPromotionsRuleAttributeOptionsRule_type * summary: List Rule Attribute Options - * description: Retrieve a list of rule attribute options in a promotion. The rule - * attribute options can be filtered by fields like FILTER FIELDS. The rule - * attribute options can also be paginated. + * description: Retrieve a list of rule attribute options in a promotion. The rule attribute options can be filtered by fields like FILTER FIELDS. The rule attribute options can also be paginated. * x-authenticated: true * parameters: * - name: rule_type @@ -13,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is - * ascending. To change the order to descending, prefix the field name with - * `-`. * - name: promotion_type * in: query * description: The promotion's promotion type. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts index e40078191e..0df9059514 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id} * operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id * summary: "List " - * description: Retrieve a list of in a promotion. The can be filtered by fields - * like FILTER FIELDS. The can also be paginated. + * description: Retrieve a list of in a promotion. The can be filtered by fields like FILTER FIELDS. The can also be paginated. * x-authenticated: true * parameters: * - name: rule_type @@ -28,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: promotion_type * in: query * description: The promotion's promotion type. @@ -91,11 +82,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl - * '{backend_url}/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}' - * \ - * + * source: |- + * curl '{backend_url}/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Promotions diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts index 39bbc18403..6f2d71b32c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/refund-reasons * operationId: GetRefundReasons * summary: List Refund Reasons - * description: Retrieve a list of refund reasons. The refund reasons can be - * filtered by fields such as `id`. The refund reasons can also be sorted or - * paginated. + * description: Retrieve a list of refund reasons. The refund reasons can be filtered by fields such as `id`. The refund reasons can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts index 2ee35f1213..9f2741d5a3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/refund-reasons/{id} * operationId: GetRefundReasonsId * summary: Get a Refund Reason - * description: Retrieve a refund reason by its ID. You can expand the refund - * reason's relations or select the fields that should be returned. + * description: Retrieve a refund reason by its ID. You can expand the refund reason's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts index d510a686aa..b592e2237c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/regions * operationId: GetRegions * summary: List Regions - * description: Retrieve a list of regions. The regions can be filtered by fields - * such as `id`. The regions can also be sorted or paginated. + * description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The region's q. @@ -110,104 +101,17 @@ * in: query * description: The region's created at. * required: false - * schema: - * type: string - * description: The region's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The region's updated at. * required: false - * schema: - * type: string - * description: The region's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The region's deleted at. * required: false - * schema: - * type: string - * description: The region's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts index 3f0c75ab58..0e8407fffe 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/regions/{id} * operationId: GetRegionsId * summary: Get a Region - * description: Retrieve a region by its ID. You can expand the region's relations - * or select the fields that should be returned. + * description: Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts index e6dbbb35ab..a4b72e95fd 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/reservations * operationId: GetReservations * summary: List Reservations - * description: Retrieve a list of reservations. The reservations can be filtered - * by fields such as `id`. The reservations can also be sorted or paginated. + * description: Retrieve a list of reservations. The reservations can be filtered by fields such as `id`. The reservations can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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: location_id * in: query * required: false @@ -184,104 +175,17 @@ * in: query * description: The reservation's created at. * required: false - * schema: - * type: string - * description: The reservation's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The reservation's updated at. * required: false - * schema: - * type: string - * description: The reservation's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The reservation's deleted at. * required: false - * schema: - * type: string - * description: The reservation's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts index 28463623b8..aa8c628c34 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/reservations/{id} * operationId: GetReservationsId * summary: Get a Reservation - * description: Retrieve a reservation by its ID. You can expand the reservation's - * relations or select the fields that should be returned. + * description: Retrieve a reservation by its ID. You can expand the reservation's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts index 0999aff61b..5df9528f5e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/return-reasons * operationId: GetReturnReasons * summary: List Return Reasons - * description: Retrieve a list of return reasons. The return reasons can be - * filtered by fields such as `id`. The return reasons can also be sorted or - * paginated. + * description: Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The return reason's q. @@ -139,29 +129,17 @@ * in: query * description: The return reason's created at. * required: false - * schema: - * type: string - * format: date-time - * title: created_at - * description: The return reason's created at. + * schema: {} * - name: updated_at * in: query * description: The return reason's updated at. * required: false - * schema: - * type: string - * format: date-time - * title: updated_at - * description: The return reason's updated at. + * schema: {} * - name: deleted_at * in: query * description: The return reason's deleted at. * required: false - * schema: - * type: string - * format: date-time - * title: deleted_at - * description: The return reason's deleted at. + * schema: {} * - name: $and * in: query * description: The return reason's $and. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts index 951c7b5854..3d612c5102 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/return-reasons/{id} * operationId: GetReturnReasonsId * summary: Get a Return Reason - * description: Retrieve a return reason by its ID. You can expand the return - * reason's relations or select the fields that should be returned. + * description: Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts index e10da246aa..0f1c73c2ac 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/returns * operationId: GetReturns * summary: List Returns - * description: Retrieve a list of returns. The returns can be filtered by fields - * such as `id`. The returns can also be sorted or paginated. + * description: Retrieve a list of returns. The returns can be filtered by fields such as `id`. The returns can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts index 5c4ff2f972..7d22c1faab 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/returns/{id} * operationId: GetReturnsId * summary: Get a Return - * description: Retrieve a return by its ID. You can expand the return's relations - * or select the fields that should be returned. + * description: Retrieve a return by its ID. You can expand the return's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts index c9483a7e91..b28786496f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/sales-channels * operationId: GetSalesChannels * summary: List Sales Channels - * description: Retrieve a list of sales channels. The sales channels can be - * filtered by fields such as `id`. The sales channels can also be sorted or - * paginated. + * description: Retrieve a list of sales channels. The sales channels can be filtered by fields such as `id`. The sales channels can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The sales channel's q. @@ -104,7 +94,7 @@ * - name: is_disabled * in: query * description: The sales channel's is disabled. - * required: true + * required: false * schema: * type: boolean * title: is_disabled @@ -113,104 +103,17 @@ * in: query * description: The sales channel's created at. * required: false - * schema: - * type: string - * description: The sales channel's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The sales channel's updated at. * required: false - * schema: - * type: string - * description: The sales channel's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The sales channel's deleted at. * required: false - * schema: - * type: string - * description: The sales channel's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: location_id * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts index f639a5af30..15162ed20d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/sales-channels/{id} * operationId: GetSalesChannelsId * summary: Get a Sales Channel - * description: Retrieve a sales channel by its ID. You can expand the sales - * channel's relations or select the fields that should be returned. + * description: Retrieve a sales channel by its ID. You can expand the sales channel's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts index 818982bd03..64313b087e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/shipping-options * operationId: GetShippingOptions * summary: List Shipping Options - * description: Retrieve a list of shipping options. The shipping options can be - * filtered by fields such as `id`. The shipping options can also be sorted or - * paginated. + * description: Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 @@ -139,104 +129,17 @@ * in: query * description: The shipping option's created at. * required: false - * schema: - * type: string - * description: The shipping option's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The shipping option's updated at. * required: false - * schema: - * type: string - * description: The shipping option's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The shipping option's deleted at. * required: false - * schema: - * type: string - * description: The shipping option's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: stock_location_id * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts index 685ade7a06..cc7c26eba5 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/shipping-profiles * operationId: GetShippingProfiles * summary: List Shipping Profiles - * description: Retrieve a list of shipping profiles. The shipping profiles can be - * filtered by fields such as `id`. The shipping profiles can also be sorted or - * paginated. + * description: Retrieve a list of shipping profiles. The shipping profiles can be filtered by fields such as `id`. The shipping profiles can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 @@ -99,104 +89,17 @@ * in: query * description: The shipping profile's created at. * required: false - * schema: - * type: string - * description: The shipping profile's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The shipping profile's updated at. * required: false - * schema: - * type: string - * description: The shipping profile's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The shipping profile's deleted at. * required: false - * schema: - * type: string - * description: The shipping profile's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts index a15d7ba00e..56e04c5140 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/shipping-profiles/{id} * operationId: GetShippingProfilesId * summary: Get a Shipping Profile - * description: Retrieve a shipping profile by its ID. You can expand the shipping - * profile's relations or select the fields that should be returned. + * description: Retrieve a shipping profile by its ID. You can expand the shipping profile's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts index df6aebae34..69d5d9b4a2 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/stock-locations * operationId: GetStockLocations * summary: List Stock Locations - * description: Retrieve a list of stock locations. The stock locations can be - * filtered by fields such as `id`. The stock locations can also be sorted or - * paginated. + * description: Retrieve a list of stock locations. The stock locations can be filtered by fields such as `id`. The stock locations can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The stock location's q. @@ -125,104 +115,17 @@ * in: query * description: The stock location's created at. * required: false - * schema: - * type: string - * description: The stock location's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The stock location's updated at. * required: false - * schema: - * type: string - * description: The stock location's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The stock location's deleted at. * required: false - * schema: - * type: string - * description: The stock location's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts index a1bd263bfb..f55e21b90c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/stock-locations/{id} * operationId: GetStockLocationsId * summary: Get a Stock Location - * description: Retrieve a stock location by its ID. You can expand the stock - * location's relations or select the fields that should be returned. + * description: Retrieve a stock location by its ID. You can expand the stock location's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts index dce54b5bfa..9758051361 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/stores * operationId: GetStores * summary: List Stores - * description: Retrieve a list of stores. The stores can be filtered by fields - * such as `id`. The stores can also be sorted or paginated. + * description: Retrieve a list of stores. The stores can be filtered by fields such as `id`. The stores can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The store's q. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts index 3209f7d7c7..d9129ae0f7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/stores/{id} * operationId: GetStoresId * summary: Get a Store - * description: Retrieve a store by its ID. You can expand the store's relations or - * select the fields that should be returned. + * description: Retrieve a store by its ID. You can expand the store's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts index 5cdcaa8abb..7923f60e6a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/tax-rates * operationId: GetTaxRates * summary: List Tax Rates - * description: Retrieve a list of tax rates. The tax rates can be filtered by - * fields such as `id`. The tax rates can also be sorted or paginated. + * description: Retrieve a list of tax rates. The tax rates can be filtered by fields such as `id`. The tax rates can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The tax rate's q. @@ -118,104 +109,17 @@ * in: query * description: The tax rate's created at. * required: false - * schema: - * type: string - * description: The tax rate's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The tax rate's updated at. * required: false - * schema: - * type: string - * description: The tax rate's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The tax rate's deleted at. * required: false - * schema: - * type: string - * description: The tax rate's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts index 6041b92adf..0c9964ba9f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/tax-rates/{id} * operationId: GetTaxRatesId * summary: Get a Tax Rate - * description: Retrieve a tax rate by its ID. You can expand the tax rate's - * relations or select the fields that should be returned. + * description: Retrieve a tax rate by its ID. You can expand the tax rate's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts index bf3f38c013..f9d6dbd043 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/tax-regions * operationId: GetTaxRegions * summary: List Tax Regions - * description: Retrieve a list of tax regions. The tax regions can be filtered by - * fields such as `id`. The tax regions can also be sorted or paginated. + * description: Retrieve a list of tax regions. The tax regions can be filtered by fields such as `id`. The tax regions can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: q * in: query * description: The tax region's q. @@ -222,104 +213,17 @@ * in: query * description: The tax region's created at. * required: false - * schema: - * type: string - * description: The tax region's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The tax region's updated at. * required: false - * schema: - * type: string - * description: The tax region's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The tax region's deleted at. * required: false - * schema: - * type: string - * description: The tax region's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts index 95d71d5662..58c6e29966 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/tax-regions/{id} * operationId: GetTaxRegionsId * summary: Get a Tax Region - * description: Retrieve a tax region by its ID. You can expand the tax region's - * relations or select the fields that should be returned. + * description: Retrieve a tax region by its ID. You can expand the tax region's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts index a9f25bbeae..b068a78ec6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/uploads/{id} * operationId: GetUploadsId * summary: Get a Upload - * description: Retrieve a upload by its ID. You can expand the upload's relations - * or select the fields that should be returned. + * description: Retrieve a upload by its ID. You can expand the upload's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts index 9856a12991..16517a4362 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/users * operationId: GetUsers * summary: List Users - * description: Retrieve a list of users. The users can be filtered by fields such - * as `id`. The users can also be sorted or paginated. + * description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts index b8d75c1f41..5695c38aee 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/users/{id} * operationId: GetUsersId * summary: Get a User - * description: Retrieve a user by its ID. You can expand the user's relations or - * select the fields that should be returned. + * description: Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts index 3bb4222eda..de31fd17cf 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts @@ -2,8 +2,7 @@ * @oas [get] /admin/users/me * operationId: GetUsersMe * summary: List Users - * description: Retrieve a list of users. The users can be filtered by fields such - * as `id`. The users can also be sorted or paginated. + * description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts index 2346aa4d74..acfb831901 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/workflows-executions * operationId: GetWorkflowsExecutions * summary: List Workflows Executions - * description: Retrieve a list of workflows executions. The workflows executions - * can be filtered by fields such as `id`. The workflows executions can also be - * sorted or paginated. + * description: Retrieve a list of workflows executions. The workflows executions can be filtered by fields such as `id`. The workflows executions can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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: transaction_id * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts index 0c18ecc91f..e2b83b4652 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/workflows-executions/{id} * operationId: GetWorkflowsExecutionsId * summary: Get a Workflows Execution - * description: Retrieve a workflows execution by its ID. You can expand the - * workflows execution's relations or select the fields that should be returned. + * description: Retrieve a workflows execution by its ID. You can expand the workflows execution's relations or select the fields that should be returned. * x-authenticated: true * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts index 98ea56f276..8574f9fd15 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts @@ -2,8 +2,7 @@ * @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id} * operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id * summary: "List " - * description: Retrieve a list of in a workflows execution. The can be filtered - * by fields like FILTER FIELDS. The can also be paginated. + * description: Retrieve a list of in a workflows execution. The can be filtered by fields like FILTER FIELDS. The can also be paginated. * x-authenticated: true * parameters: * - name: workflow_id @@ -28,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -75,11 +66,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl - * '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}' - * \ - * + * source: |- + * curl '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Workflows Executions diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts index e0bd224674..96873b3b51 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe * operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe * summary: List Subscribes - * description: Retrieve a list of subscribes in a workflows execution. The - * subscribes can be filtered by fields like FILTER FIELDS. The subscribes can - * also be paginated. + * description: Retrieve a list of subscribes in a workflows execution. The subscribes can be filtered by fields like FILTER FIELDS. The subscribes can also be paginated. * x-authenticated: true * parameters: * - name: workflow_id @@ -25,56 +23,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -82,11 +30,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl - * '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe' - * \ - * + * source: |- + * curl '{backend_url}/admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Workflows Executions diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts index 671f4b5564..e5a9240e86 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts @@ -2,9 +2,7 @@ * @oas [get] /admin/workflows-executions/{workflow_id}/subscribe * operationId: GetWorkflowsExecutionsWorkflow_idSubscribe * summary: List Subscribes - * description: Retrieve a list of subscribes in a workflows execution. The - * subscribes can be filtered by fields like FILTER FIELDS. The subscribes can - * also be paginated. + * description: Retrieve a list of subscribes in a workflows execution. The subscribes can be filtered by fields like FILTER FIELDS. The subscribes can also be paginated. * x-authenticated: true * parameters: * - name: workflow_id @@ -13,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts index b8bb3bf520..cd5f970756 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts @@ -4,57 +4,7 @@ * summary: Create Api Key * description: Create a api key. * x-authenticated: true - * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts index 6dc1ef2543..f5a11aa895 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -101,6 +93,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateApiKeysWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts index 8828d6cc7a..c03ddb47ec 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -97,6 +89,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: revokeApiKeysWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts index 5411d0ccdc..644abbfd74 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: linkSalesChannelsToApiKeyWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts index 81d7040950..6ce381c13b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -135,9 +127,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -174,6 +164,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createCampaignsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts index 486abb3814..0e07a76c7e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -127,9 +119,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -164,6 +154,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCampaignsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts index 9546a6d028..6a0688706c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: addOrRemoveCampaignPromotionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts index 45aec2794c..bf4ea8e1e6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -97,6 +89,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: beginClaimOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts index 700b0b38bf..fc46e278db 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -97,6 +47,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelOrderClaimWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts index 7e77946f1e..0667a8a577 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts index f672b7679b..5c90da7ff3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts index ea1eeeacd5..1fc9b1a97c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts index 1c212aa225..6e686442e2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts @@ -17,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts index 47da9c3104..ed31af6f33 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts index de428c0372..2d01cb862e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Claims diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts index 79391bb6b7..360a102487 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts index 72312b8d82..b8883eb858 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Claims diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts index c23f6f1311..97be389861 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts index 74fad929a9..95e57f7198 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Claims diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts index cd1ffabc38..7dc902415a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts index a9c79d8585..8bf05e6d63 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts index 66bfbeccdf..a18b5fe09e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -101,6 +93,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCollectionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts index ea6788cafa..39f230e2f2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchLinkProductsToCollectionWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts index 95b6715c41..cd918486b6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -96,6 +88,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createCustomerGroupsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts index 0e0e63cc7c..002949d537 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -102,6 +94,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCustomerGroupsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts index 84ddc4b19b..17d3c68b43 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: linkCustomersToCustomerGroupWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts index 0d5e7ab719..d5b6398820 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -103,9 +95,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -143,6 +133,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createCustomersWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts index bc3ece80c0..6d8e060457 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -109,9 +101,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -149,6 +139,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCustomersWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index 63aee37f43..0818a7a6d4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -146,9 +138,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -192,6 +182,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createCustomerAddressesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index 2211b7e30e..23d79bd0b9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -152,9 +144,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -198,6 +188,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCustomerAddressesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts index c773570326..d3a38c13ce 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -351,9 +343,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts index e51c0e48f3..19b4b504e3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -96,6 +88,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: beginExchangeOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts index df00eed867..182bcc0cc6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -97,6 +47,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelOrderExchangeWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts index 08dfe6add7..d5a8b41dbe 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts index c9499b18c2..9c038ab892 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -17,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +29,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Exchanges diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts index fe5cd379c7..19a6d711e4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,14 +23,10 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method' \ * -H 'x-medusa-access-token: {api_token}' \ - * * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "shipping_option_id": "{value}" * }' diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index eeee41b1a0..c320a31839 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Exchanges diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts index 6092f5c967..78ec551dc4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts index da78e85c2a..e11cfc95a5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Exchanges diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts index 594a65edea..0aec88fab3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,14 +65,10 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method' \ * -H 'x-medusa-access-token: {api_token}' \ - * * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "shipping_option_id": "{value}" * }' diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index 44788d4cc9..89d945757a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,11 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Exchanges diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts index c7576ca5d2..d56e9b556d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts index d7958db8cc..b1ab77bcea 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -215,6 +207,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createServiceZonesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 3c5d806048..872ad20b4d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -209,14 +201,10 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ * -H 'x-medusa-access-token: {api_token}' \ - * * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "name": "Elvis" * }' @@ -241,6 +229,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateServiceZonesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts index 371d2e21ce..c8794ac946 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts index 9d44d07d98..10ca2ef1f7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -97,6 +89,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelFulfillmentWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts index e71067408a..0017b0c046 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -107,6 +99,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createShipmentWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts index bbd236c027..0832ff009e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts index 8ed04ec46f..b61a4a48d5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -184,6 +176,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateInventoryItemsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts index cbfe7f0c0f..36e2121de4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -117,6 +109,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createInventoryLevelsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts index a790fdefa6..0ad36543a3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -89,10 +81,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Inventory Items @@ -115,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateInventoryLevelsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts index 22a31ce2d7..093908cabb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -118,10 +68,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Inventory Items @@ -151,6 +99,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: bulkCreateDeleteLevelsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts index da8fb27c1b..e7c1cbb5e5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -99,6 +91,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createInvitesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts index f1cf11a1a2..c25923db27 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -90,6 +82,7 @@ * content: * application/json: * schema: {} + * x-workflow: refreshInviteTokensWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts index 5b60bc170b..2de5c7d9df 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -127,6 +119,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: acceptInviteWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts index 4d22f4da4a..3c0d395ebf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts @@ -4,57 +4,7 @@ * summary: Create Order Edit * description: Create a order edit. * x-authenticated: true - * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -96,6 +46,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: beginOrderEditOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts index 938e2c71d9..a6243c85b2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_confirm.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts index 7ecfc8bb72..836af855bc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts index 86b11621ac..9defcbd7f5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_[action_id].ts @@ -17,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_id].ts index 3d8f52b566..1118185c9a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_items_item_[item_id].ts @@ -17,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts index 751fbe3c74..4d2e6af10c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts index e9203e6494..61bfa43706 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts index b4cc1096f3..43442ba6dc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_shipping-method_[action_id].ts @@ -17,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +29,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/order-edits/{id}/shipping-method/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Order Edits diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts index 0bd0a2bd36..83076251a4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts index 21dd6f81cb..898c57c1a7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -101,6 +93,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: archiveOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts index 9246ce26bf..05c9ac3b03 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -96,6 +88,7 @@ * content: * application/json: * schema: {} + * x-workflow: cancelOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts index ae566eaf9d..9cb49989c2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -84,9 +76,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -119,6 +109,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: completeOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts index 5eee660528..d8aaa52002 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -111,9 +103,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -153,6 +143,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createOrderFulfillmentWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts index f2e28f90cd..59441f9378 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -88,17 +80,13 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Orders @@ -121,6 +109,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: cancelOrderFulfillmentWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts index 56d92e8b2d..306963f6af 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -135,22 +127,15 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipments' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipments' \ * -H 'x-medusa-access-token: {api_token}' \ - * * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "items": [ * { @@ -181,6 +166,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createOrderShipmentWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts index b681543b3b..08bb309211 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts index 0a682bcd61..29d1d82974 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -109,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: markPaymentCollectionAsPaid * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts index dc19861417..584ffd0666 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -103,6 +95,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: capturePaymentWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts index 3b702f9193..ad9fa0bb0f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -111,6 +103,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: refundPaymentWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts index 888c69a1e9..8661e97e71 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -98,6 +90,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createPriceListsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts index 38d0b9fdaa..d208d540cb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -103,6 +95,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updatePriceListsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts index 3409d4b9b6..e8c481a674 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -181,6 +131,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchPriceListPricesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts index c5504a182e..50f7f37465 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchPriceListPricesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts index 9947f1bbe2..0246c8d9e1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -91,6 +83,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createPricePreferencesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts index 0e4ab7a2dd..5cc7d9e030 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -97,6 +89,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updatePricePreferencesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts index 0b32f0e3cd..86adaa8ae0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts index 522606ab97..6348d9d70d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -138,6 +130,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateProductCategoriesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts index eca3bf2abf..d0e0e7a81a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchLinkProductsToCategoryWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts index 8a6f0f9a2a..d6931b3634 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts index 65791fe6d7..2e69051e5e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts index 36a94cd54b..edad228db8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts index ff0700217d..3316bce1bd 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts index 8f29462977..852ba2f7fa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -70,9 +62,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts index ac77699489..f79ae9c031 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -76,9 +68,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts index ab3f1be315..3a8d63c290 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -76,9 +68,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -114,6 +104,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createProductOptionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts index 47a6d23f2c..13fe4ff470 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -82,9 +74,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -113,6 +103,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateProductOptionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts index c0dcb87603..63c5e2fd8b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -76,9 +68,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -112,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createProductVariantsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts index 151b15be14..58aecaee35 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -82,9 +74,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -113,6 +103,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateProductVariantsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts index f46c72bd67..3a6d03d7bb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,15 +71,10 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items' \ * -H 'x-medusa-access-token: {api_token}' \ - * * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "required_quantity": 7390879820021760, * "inventory_item_id": "{value}" @@ -113,6 +100,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createLinksWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts index 5fd80d8b7b..e680753fa8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -33,18 +33,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -63,16 +59,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -85,15 +77,10 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ * -H 'x-medusa-access-token: {api_token}' \ - * * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "required_quantity": 5324804697620480 * }' @@ -118,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateLinksWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts index d2d881b5d3..844567d4fa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts index 6617d37e58..be25b7597a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -139,10 +89,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/products/{id}/variants/inventory-items/batch' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}/variants/inventory-items/batch' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Products diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts index 106fb62308..ce2a5bff19 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts index 4bebe70f3e..b8ef827426 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts index 239081f8f1..6dc6880780 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts @@ -4,57 +4,7 @@ * summary: Create Product * description: Create a product. * x-authenticated: true - * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts index 59711f3e4f..003d6acf5a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import_[transaction_id]_confirm.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -68,10 +18,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/products/import/{transaction_id}/confirm' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/products/import/{transaction_id}/confirm' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Products @@ -92,6 +40,7 @@ * content: * application/json: * schema: {} + * x-workflow: importProductsWorkflowId * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts index c12c0c3a54..0e3ec051df 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -337,9 +329,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -387,6 +377,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createPromotionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts index 50daa379a4..5267899210 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -337,9 +329,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -372,6 +362,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updatePromotionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts index 6ad756fdfa..6d47ff4028 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts index da78a2913b..504d0b778a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts index b6b4a7a795..ae769825f3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts index 30f6d9ca4f..9b2fecba0c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts index 6b44caa81b..0a94a05df6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateRefundReasonsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts index 72ca9ddf44..86907d9ab0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts index 2d7e62a08f..9e63bb5aaa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts index bb903bc394..50220ba218 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts index 3accd3208d..8f306aec76 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -122,6 +114,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateReservationsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts index d184d93a88..f91fab2ae5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -96,6 +88,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createReturnReasonsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts index 5ae40aa4b2..a1fe646bc3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -97,6 +89,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateReturnReasonsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts index 54e97adb57..47d9401c18 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -109,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: beginReturnOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts index 801b94204f..d46a9020b0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts index d0046fd0cc..27b88431c1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -97,6 +47,7 @@ * application/json: * schema: * $ref: "#/components/schemas/AdminPostCancelReturnReqSchema" + * x-workflow: cancelReturnWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts index 24c4e07910..4170a42d2c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts index 4f06a2d609..36b2bbef2f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/dismiss-items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Returns diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts index 63b936950e..427e871048 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts index e8d58bcb39..dea6c7d01b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/returns/{id}/receive-items/{action_id}' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/receive-items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Returns diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts index dfbb9c7e6b..185e056c44 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -110,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: beginReceiveReturnWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts index d6e975ceda..5d45445a95 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts index cac4a5d19b..0d2d44dae7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts index 7128caf3a9..af49c6fb88 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/returns/{id}/request-items/{action_id}' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/request-items/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Returns diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts index 3ece8deb6e..5f95e92ffe 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts index cc89e06a11..d38b43a8e1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts index d18f73c078..a906707482 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -79,10 +71,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/shipping-method/{action_id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Returns diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts index 4de13004c7..76a58768c9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts index 5dc81f2170..39f618ca0f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -102,6 +94,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateSalesChannelsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts index 229b5f0b62..7910dace14 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: linkProductsToSalesChannelWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts index 41ec790612..dce3a80d0d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -229,6 +221,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createShippingOptionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts index 4d6df77fb6..664999a6bb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -250,6 +242,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateShippingOptionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts index f547cb64d4..2859bf9402 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts index 10ac6f76bc..e43cdc2311 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts index 3f4319ff7b..cee61ac725 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -116,6 +108,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateShippingProfilesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts index 5d5b025a9d..1930dc227c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts index ef85424321..af1b87b2e6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -102,6 +94,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateStockLocationsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts index cb69f04b89..b55a66d449 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -89,10 +81,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/stock-locations/{id}/fulfillment-providers' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-providers' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Stock Locations @@ -115,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: batchLinksWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts index 7e9c69868e..52c6ed8dc6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -115,6 +107,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createLocationFulfillmentSetWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts index 3e4410f018..74f06cef43 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -113,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: linkSalesChannelsToStockLocationWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts index f211969a32..c028fe432b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts index 158d0f8e1d..133cc9b477 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts index 1437ee1102..8f0aa0e90b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -101,6 +93,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateTaxRatesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts index 90be53e9c8..e05c67a1b7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -102,6 +94,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createTaxRateRulesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts index 62b7f192fd..ef9f5da634 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts index 08ae7a9008..ccc3fc4e24 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts @@ -4,57 +4,7 @@ * summary: Create Upload * description: Create a upload. * x-authenticated: true - * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts index 62571f973c..d082892800 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -98,6 +90,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateUsersWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts index e82d2ca715..9393218f9b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,10 +23,8 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/run' - * \ - * + * source: |- + * curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/run' \ * -H 'x-medusa-access-token: {api_token}' * tags: * - Workflows Executions diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts index 3e45ff47e1..2b8bcda4ab 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,14 +23,10 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/workflows-executions/{workflow_id}/steps/failure' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/steps/failure' \ * -H 'x-medusa-access-token: {api_token}' \ - * * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "transaction_id": "{value}", * "step_id": "{value}" diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts index 0df89484df..1ff8238158 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,14 +23,10 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/workflows-executions/{workflow_id}/steps/success' \ - * + * source: |- + * curl -X POST '{backend_url}/admin/workflows-executions/{workflow_id}/steps/success' \ * -H 'x-medusa-access-token: {api_token}' \ - * * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "transaction_id": "{value}", * "step_id": "{value}" diff --git a/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts b/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts index 9292735b7c..3be8983e2d 100644 --- a/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts +++ b/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts @@ -4,57 +4,7 @@ * summary: Delete Session * description: Delete Session * x-authenticated: false - * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider].ts b/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider].ts index 56c243dd12..6066bb3478 100644 --- a/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider].ts +++ b/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider].ts @@ -2,8 +2,7 @@ * @oas [get] /auth/{actor_type}/{auth_provider} * operationId: GetActor_typeAuth_provider * summary: "List " - * description: Retrieve a list of in a [actor_type]. The can be filtered by - * fields like FILTER FIELDS. The can also be paginated. + * description: Retrieve a list of in a [actor_type]. The can be filtered by fields like FILTER FIELDS. The can also be paginated. * x-authenticated: false * parameters: * - name: actor_type @@ -18,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider]_callback.ts b/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider]_callback.ts index 0c01121fbe..e845b9cb41 100644 --- a/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider]_callback.ts +++ b/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider]_callback.ts @@ -2,8 +2,7 @@ * @oas [get] /auth/{actor_type}/{auth_provider}/callback * operationId: GetActor_typeAuth_providerCallback * summary: List Callbacks - * description: Retrieve a list of callbacks in a [actor_type]. The callbacks can - * be filtered by fields like FILTER FIELDS. The callbacks can also be paginated. + * description: Retrieve a list of callbacks in a [actor_type]. The callbacks can be filtered by fields like FILTER FIELDS. The callbacks can also be paginated. * x-authenticated: false * parameters: * - name: actor_type @@ -18,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts index 3b39b42269..4ec6265a58 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts @@ -17,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts index 6ab0a30dcd..8614619a0d 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts @@ -17,56 +17,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts new file mode 100644 index 0000000000..a61767ca37 --- /dev/null +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /auth/{actor_type}/{auth_provider}/register + * operationId: PostActor_typeAuth_providerRegister + * summary: Add Register to [actor_type] + * description: Add a Register to a [actor_type] + * x-authenticated: false + * parameters: + * - name: actor_type + * in: path + * description: The [actor type]'s actor type. + * required: true + * schema: + * type: string + * - name: auth_provider + * in: path + * description: The [actor type]'s auth provider. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}/register' + * tags: + * - "[actor_type]" + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_session.ts b/www/utils/generated/oas-output/operations/auth/post_auth_session.ts index 3b232252d0..439565ac24 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_session.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_session.ts @@ -4,57 +4,7 @@ * summary: Create Session * description: Create a session. * x-authenticated: false - * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts b/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts index 37a8900d58..52edfaeee1 100644 --- a/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts +++ b/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts @@ -11,56 +11,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts index 8db434464b..43a2175cb4 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts @@ -2,8 +2,7 @@ * @oas [delete] /store/carts/{id}/line-items/{line_id} * operationId: DeleteCartsIdLineItemsLine_id * summary: Remove Line Items from Cart - * description: Remove a list of line items from a cart. This doesn't delete the - * Line Item, only the association between the Line Item and the cart. + * description: Remove a list of line items from a cart. This doesn't delete the Line Item, only the association between the Line Item and the cart. * x-authenticated: false * parameters: * - name: id @@ -28,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -58,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -114,6 +105,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteLineItemsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts index dbcc301ee3..0fdbf6ba94 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts @@ -2,8 +2,7 @@ * @oas [delete] /store/carts/{id}/promotions * operationId: DeleteCartsIdPromotions * summary: Remove Promotions from Cart - * description: Remove a list of promotions from a cart. This doesn't delete the - * Promotion, only the association between the Promotion and the cart. + * description: Remove a list of promotions from a cart. This doesn't delete the Promotion, only the association between the Promotion and the cart. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -93,6 +84,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCartPromotionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts index e1161c34f4..e05bc2157a 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts @@ -2,8 +2,7 @@ * @oas [delete] /store/customers/me/addresses/{address_id} * operationId: DeleteCustomersMeAddressesAddress_id * summary: Remove Addresses from Customer - * description: Remove a list of addresses from a customer. This doesn't delete the - * Address, only the association between the Address and the customer. + * description: Remove a list of addresses from a customer. This doesn't delete the Address, only the association between the Address and the customer. * x-authenticated: true * parameters: * - name: address_id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - cookie_auth: [] * - jwt_token: [] @@ -113,6 +104,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: deleteCustomerAddressesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts index f9da20f418..06fc94df2b 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /store/carts/{id} * operationId: GetCartsId * summary: Get a Cart - * description: Retrieve a cart by its ID. You can expand the cart's relations or - * select the fields that should be returned. + * description: Retrieve a cart by its ID. You can expand the cart's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections.ts b/www/utils/generated/oas-output/operations/store/get_store_collections.ts index 3f7ec46c4e..80739e9b79 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections.ts @@ -2,8 +2,7 @@ * @oas [get] /store/collections * operationId: GetCollections * summary: List Collections - * description: Retrieve a list of collections. The collections can be filtered by - * fields such as `id`. The collections can also be sorted or paginated. + * description: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts index f8482af738..ec80a84a6a 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /store/collections/{id} * operationId: GetCollectionsId * summary: Get a Collection - * description: Retrieve a collection by its ID. You can expand the collection's - * relations or select the fields that should be returned. + * description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts index b0b2a3bc86..11f202cc29 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts @@ -2,8 +2,7 @@ * @oas [get] /store/currencies * operationId: GetCurrencies * summary: List Currencies - * description: Retrieve a list of currencies. The currencies can be filtered by - * fields such as `id`. The currencies can also be sorted or paginated. + * description: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts index 8400d335df..4650c55703 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts @@ -2,8 +2,7 @@ * @oas [get] /store/currencies/{code} * operationId: GetCurrenciesCode * summary: Get a Currency - * description: Retrieve a currency by its ID. You can expand the currency's - * relations or select the fields that should be returned. + * description: Retrieve a currency by its ID. You can expand the currency's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: code @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts index 26c9dffca8..105eb5e896 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts @@ -2,8 +2,7 @@ * @oas [get] /store/customers/me * operationId: GetCustomersMe * summary: List Customers - * description: Retrieve a list of customers. The customers can be filtered by - * fields such as `id`. The customers can also be sorted or paginated. + * description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - cookie_auth: [] * - jwt_token: [] diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts index c12116a44d..2a51dbdefc 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -2,8 +2,7 @@ * @oas [get] /store/customers/me/addresses * operationId: GetCustomersMeAddresses * summary: List Customers - * description: Retrieve a list of customers. The customers can be filtered by - * fields such as `id`. The customers can also be sorted or paginated. + * description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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: metadata * in: query * description: The customer's metadata. diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts index f3c31d9394..362e67819e 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts @@ -2,8 +2,7 @@ * @oas [get] /store/customers/me/addresses/{address_id} * operationId: GetCustomersMeAddressesAddress_id * summary: List Addresses - * description: Retrieve a list of addresses in a customer. The addresses can be - * filtered by fields like FILTER FIELDS. The addresses can also be paginated. + * description: Retrieve a list of addresses in a customer. The addresses can be filtered by fields like FILTER FIELDS. The addresses can also be paginated. * x-authenticated: true * parameters: * - name: address_id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - cookie_auth: [] * - jwt_token: [] diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders.ts b/www/utils/generated/oas-output/operations/store/get_store_orders.ts index 78e12ec717..fdf4f8e9da 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders.ts @@ -2,8 +2,7 @@ * @oas [get] /store/orders * operationId: GetOrders * summary: List Orders - * description: Retrieve a list of orders. The orders can be filtered by fields - * such as `id`. The orders can also be sorted or paginated. + * description: Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts index bea746b415..c8b3df4636 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /store/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. + * description: Retrieve a order by its ID. You can expand the order's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts index d35e0e2402..876c1a487c 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts @@ -2,9 +2,7 @@ * @oas [get] /store/payment-providers * operationId: GetPaymentProviders * 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. + * 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: false * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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: region_id * in: query * description: The payment provider's region id. diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts index d2b3335258..8c8b75883a 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts @@ -2,9 +2,7 @@ * @oas [get] /store/product-categories * operationId: GetProductCategories * summary: List Product Categories - * description: Retrieve a list of product categories. The product categories can - * be filtered by fields such as `id`. The product categories can also be sorted - * or paginated. + * description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. @@ -124,7 +114,7 @@ * - name: include_ancestors_tree * in: query * description: The product category's include ancestors tree. - * required: true + * required: false * schema: * type: boolean * title: include_ancestors_tree @@ -132,7 +122,7 @@ * - name: include_descendants_tree * in: query * description: The product category's include descendants tree. - * required: true + * required: false * schema: * type: boolean * title: include_descendants_tree @@ -141,104 +131,17 @@ * in: query * description: The product category's created at. * required: false - * schema: - * type: string - * description: The product category's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: created_at + * schema: {} * - name: updated_at * in: query * description: The product category's updated at. * required: false - * schema: - * type: string - * description: The product category's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: updated_at + * schema: {} * - name: deleted_at * in: query * description: The product category's deleted at. * required: false - * schema: - * type: string - * description: The product category's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * title: deleted_at + * schema: {} * - name: $and * in: query * required: false diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts index fb1c67c83f..c008e45258 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /store/product-categories/{id} * operationId: GetProductCategoriesId * summary: Get a Product Category - * description: Retrieve a product category by its ID. You can expand the product - * category's relations or select the fields that should be returned. + * description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,20 +47,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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. - * required: true + * required: false * schema: * type: boolean * title: include_ancestors_tree @@ -73,7 +64,7 @@ * - name: include_descendants_tree * in: query * description: The product category's include descendants tree. - * required: true + * required: false * schema: * type: boolean * title: include_descendants_tree diff --git a/www/utils/generated/oas-output/operations/store/get_store_products.ts b/www/utils/generated/oas-output/operations/store/get_store_products.ts index aca2290521..5fc4541d99 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products.ts @@ -2,8 +2,7 @@ * @oas [get] /store/products * operationId: GetProducts * summary: List Products - * description: Retrieve a list of products. The products can be filtered by fields - * such as `id`. The products can also be sorted or paginated. + * description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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: $and * in: query * required: false @@ -63,11 +54,9 @@ * type: array * description: The product's $and. * items: - * type: array + * type: object * description: The $and's details. - * items: &a1 - * type: object - * title: $and + * title: $and * - name: $or * in: query * required: false @@ -75,11 +64,9 @@ * type: array * description: The product's $or. * items: - * type: array + * type: object * description: The $or's details. - * items: &a2 - * type: object - * title: $or + * title: $or * - name: variants * in: query * description: The product's variants. @@ -210,1883 +197,175 @@ * type: array * description: The created at's $and. * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1165: - * type: object - * description: The $and's @match@1165. - * __@replace@1167: - * type: object - * description: The $and's @replace@1167. - * __@search@1170: - * type: object - * description: The $and's @search@1170. - * __@split@1172: - * type: object - * description: The $and's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $and's @matchall@1174. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $and's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $and's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $and's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * - type: object - * description: The $and's $not. - * - type: array - * description: The $and's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $and's $like. - * $re: - * type: string - * title: $re - * description: The $and's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $and's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $and's $fulltext. - * $overlap: - * type: array - * description: The $and's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $and's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $and's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $and's $exists. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1165: - * type: object - * description: The $and's @match@1165. - * __@replace@1167: - * type: object - * description: The $and's @replace@1167. - * __@search@1170: - * type: object - * description: The $and's @search@1170. - * __@split@1172: - * type: object - * description: The $and's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $and's @matchall@1174. + * type: object * $or: * type: array * description: The created at's $or. * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1165: - * type: object - * description: The $or's @match@1165. - * __@replace@1167: - * type: object - * description: The $or's @replace@1167. - * __@search@1170: - * type: object - * description: The $or's @search@1170. - * __@split@1172: - * type: object - * description: The $or's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $or's @matchall@1174. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $or's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $or's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $or's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * - type: object - * description: The $or's $not. - * - type: array - * description: The $or's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $or's $like. - * $re: - * type: string - * title: $re - * description: The $or's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $or's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $or's $fulltext. - * $overlap: - * type: array - * description: The $or's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $or's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $or's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $or's $exists. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1165: - * type: object - * description: The $or's @match@1165. - * __@replace@1167: - * type: object - * description: The $or's @replace@1167. - * __@search@1170: - * type: object - * description: The $or's @search@1170. - * __@split@1172: - * type: object - * description: The $or's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $or's @matchall@1174. + * type: object * $eq: * oneOf: * - type: string * title: $eq - * description: The created at's $eq. - * - type: object - * description: The created at's $eq. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1165: - * type: object - * description: The $eq's @match@1165. - * __@replace@1167: - * type: object - * description: The $eq's @replace@1167. - * __@search@1170: - * type: object - * description: The $eq's @search@1170. - * __@split@1172: - * type: object - * description: The $eq's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $eq's @matchall@1174. + * description: Filter by an exact match. * - type: array - * description: The created at's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1165: - * type: object - * description: The $eq's @match@1165. - * __@replace@1167: - * type: object - * description: The $eq's @replace@1167. - * __@search@1170: - * type: object - * description: The $eq's @search@1170. - * __@split@1172: - * type: object - * description: The $eq's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $eq's @matchall@1174. + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The created at's $ne. - * - type: object - * description: The created at's $ne. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * test: - * type: object - * description: The $ne's test. - * source: - * type: string - * title: source - * description: The $ne's source. - * global: - * type: boolean - * title: global - * description: The $ne's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $ne's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $ne's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $ne's lastindex. - * compile: - * type: object - * description: The $ne's compile. - * flags: - * type: string - * title: flags - * description: The $ne's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $ne's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $ne's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $ne's dotall. - * __@match@1165: - * type: object - * description: The $ne's @match@1165. - * __@replace@1167: - * type: object - * description: The $ne's @replace@1167. - * __@search@1170: - * type: object - * description: The $ne's @search@1170. - * __@split@1172: - * type: object - * description: The $ne's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $ne's @matchall@1174. + * type: string + * title: $ne * $in: * type: array * description: The created at's $in. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $in's exec. - * test: - * type: object - * description: The $in's test. - * source: - * type: string - * title: source - * description: The $in's source. - * global: - * type: boolean - * title: global - * description: The $in's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $in's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $in's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $in's lastindex. - * compile: - * type: object - * description: The $in's compile. - * flags: - * type: string - * title: flags - * description: The $in's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $in's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $in's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $in's dotall. - * __@match@1165: - * type: object - * description: The $in's @match@1165. - * __@replace@1167: - * type: object - * description: The $in's @replace@1167. - * __@search@1170: - * type: object - * description: The $in's @search@1170. - * __@split@1172: - * type: object - * description: The $in's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $in's @matchall@1174. + * type: string + * title: $in * $nin: * type: array * description: The created at's $nin. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * test: - * type: object - * description: The $nin's test. - * source: - * type: string - * title: source - * description: The $nin's source. - * global: - * type: boolean - * title: global - * description: The $nin's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $nin's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $nin's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $nin's lastindex. - * compile: - * type: object - * description: The $nin's compile. - * flags: - * type: string - * title: flags - * description: The $nin's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $nin's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $nin's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $nin's dotall. - * __@match@1165: - * type: object - * description: The $nin's @match@1165. - * __@replace@1167: - * type: object - * description: The $nin's @replace@1167. - * __@search@1170: - * type: object - * description: The $nin's @search@1170. - * __@split@1172: - * type: object - * description: The $nin's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $nin's @matchall@1174. + * type: string + * title: $nin * $not: * oneOf: * - type: string * title: $not - * description: The created at's $not. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The created at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1165: - * type: object - * description: The $not's @match@1165. - * __@replace@1167: - * type: object - * description: The $not's @replace@1167. - * __@search@1170: - * type: object - * description: The $not's @search@1170. - * __@split@1172: - * type: object - * description: The $not's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $not's @matchall@1174. - * - type: object - * description: The created at's $not. + * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array * description: The $not's $and. * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp + * type: object + * title: $and * $or: * type: array * description: The $not's $or. * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp + * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp + * description: Filter by an exact match. * - type: array - * description: The $not's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The $not's $in. + * description: Filter by values in this array. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp + * type: string + * title: $in + * description: Filter by values in this array. * $nin: * type: array - * description: The $not's $nin. + * description: Filter by values not in this array. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp + * type: string + * title: $nin + * description: Filter by values not in this array. * $not: * oneOf: * - type: string * title: $not - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * - type: object - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp + * 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: The $not's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The $not's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The $not's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The $not's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The $not's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: Filter arrays that have overlapping values with this parameter. * $contains: * type: array - * description: The $not's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: Filter arrays that contain some of the values of this parameter. * $contained: * type: array - * description: The $not's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: Filter arrays that contain all values of this parameter. * $exists: * type: boolean * title: $exists - * description: The $not's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: The created at's $not. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1165: - * type: object - * description: The $not's @match@1165. - * __@replace@1167: - * type: object - * description: The $not's @replace@1167. - * __@search@1170: - * type: object - * description: The $not's @search@1170. - * __@split@1172: - * type: object - * description: The $not's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $not's @matchall@1174. + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The created at's $gt. - * - type: object - * description: The created at's $gt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * test: - * type: object - * description: The $gt's test. - * source: - * type: string - * title: source - * description: The $gt's source. - * global: - * type: boolean - * title: global - * description: The $gt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gt's lastindex. - * compile: - * type: object - * description: The $gt's compile. - * flags: - * type: string - * title: flags - * description: The $gt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gt's dotall. - * __@match@1165: - * type: object - * description: The $gt's @match@1165. - * __@replace@1167: - * type: object - * description: The $gt's @replace@1167. - * __@search@1170: - * type: object - * description: The $gt's @search@1170. - * __@split@1172: - * type: object - * description: The $gt's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $gt's @matchall@1174. + * type: string + * title: $gt * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The created at's $gte. - * - type: object - * description: The created at's $gte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * test: - * type: object - * description: The $gte's test. - * source: - * type: string - * title: source - * description: The $gte's source. - * global: - * type: boolean - * title: global - * description: The $gte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gte's lastindex. - * compile: - * type: object - * description: The $gte's compile. - * flags: - * type: string - * title: flags - * description: The $gte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gte's dotall. - * __@match@1165: - * type: object - * description: The $gte's @match@1165. - * __@replace@1167: - * type: object - * description: The $gte's @replace@1167. - * __@search@1170: - * type: object - * description: The $gte's @search@1170. - * __@split@1172: - * type: object - * description: The $gte's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $gte's @matchall@1174. + * type: string + * title: $gte * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The created at's $lt. - * - type: object - * description: The created at's $lt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * test: - * type: object - * description: The $lt's test. - * source: - * type: string - * title: source - * description: The $lt's source. - * global: - * type: boolean - * title: global - * description: The $lt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lt's lastindex. - * compile: - * type: object - * description: The $lt's compile. - * flags: - * type: string - * title: flags - * description: The $lt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lt's dotall. - * __@match@1165: - * type: object - * description: The $lt's @match@1165. - * __@replace@1167: - * type: object - * description: The $lt's @replace@1167. - * __@search@1170: - * type: object - * description: The $lt's @search@1170. - * __@split@1172: - * type: object - * description: The $lt's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $lt's @matchall@1174. + * type: string + * title: $lt * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The created at's $lte. - * - type: object - * description: The created at's $lte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * test: - * type: object - * description: The $lte's test. - * source: - * type: string - * title: source - * description: The $lte's source. - * global: - * type: boolean - * title: global - * description: The $lte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lte's lastindex. - * compile: - * type: object - * description: The $lte's compile. - * flags: - * type: string - * title: flags - * description: The $lte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lte's dotall. - * __@match@1165: - * type: object - * description: The $lte's @match@1165. - * __@replace@1167: - * type: object - * description: The $lte's @replace@1167. - * __@search@1170: - * type: object - * description: The $lte's @search@1170. - * __@split@1172: - * type: object - * description: The $lte's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $lte's @matchall@1174. + * type: string + * title: $lte * $like: * type: string * title: $like @@ -2140,1883 +419,175 @@ * type: array * description: The updated at's $and. * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1165: - * type: object - * description: The $and's @match@1165. - * __@replace@1167: - * type: object - * description: The $and's @replace@1167. - * __@search@1170: - * type: object - * description: The $and's @search@1170. - * __@split@1172: - * type: object - * description: The $and's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $and's @matchall@1174. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $and's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $and's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $and's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * - type: object - * description: The $and's $not. - * - type: array - * description: The $and's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $and's $like. - * $re: - * type: string - * title: $re - * description: The $and's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $and's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $and's $fulltext. - * $overlap: - * type: array - * description: The $and's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $and's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $and's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $and's $exists. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1165: - * type: object - * description: The $and's @match@1165. - * __@replace@1167: - * type: object - * description: The $and's @replace@1167. - * __@search@1170: - * type: object - * description: The $and's @search@1170. - * __@split@1172: - * type: object - * description: The $and's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $and's @matchall@1174. + * type: object * $or: * type: array * description: The updated at's $or. * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1165: - * type: object - * description: The $or's @match@1165. - * __@replace@1167: - * type: object - * description: The $or's @replace@1167. - * __@search@1170: - * type: object - * description: The $or's @search@1170. - * __@split@1172: - * type: object - * description: The $or's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $or's @matchall@1174. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $or's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $or's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $or's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * - type: object - * description: The $or's $not. - * - type: array - * description: The $or's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $or's $like. - * $re: - * type: string - * title: $re - * description: The $or's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $or's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $or's $fulltext. - * $overlap: - * type: array - * description: The $or's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $or's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $or's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $or's $exists. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1165: - * type: object - * description: The $or's @match@1165. - * __@replace@1167: - * type: object - * description: The $or's @replace@1167. - * __@search@1170: - * type: object - * description: The $or's @search@1170. - * __@split@1172: - * type: object - * description: The $or's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $or's @matchall@1174. + * type: object * $eq: * oneOf: * - type: string * title: $eq - * description: The updated at's $eq. - * - type: object - * description: The updated at's $eq. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1165: - * type: object - * description: The $eq's @match@1165. - * __@replace@1167: - * type: object - * description: The $eq's @replace@1167. - * __@search@1170: - * type: object - * description: The $eq's @search@1170. - * __@split@1172: - * type: object - * description: The $eq's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $eq's @matchall@1174. + * description: Filter by an exact match. * - type: array - * description: The updated at's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1165: - * type: object - * description: The $eq's @match@1165. - * __@replace@1167: - * type: object - * description: The $eq's @replace@1167. - * __@search@1170: - * type: object - * description: The $eq's @search@1170. - * __@split@1172: - * type: object - * description: The $eq's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $eq's @matchall@1174. + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The updated at's $ne. - * - type: object - * description: The updated at's $ne. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * test: - * type: object - * description: The $ne's test. - * source: - * type: string - * title: source - * description: The $ne's source. - * global: - * type: boolean - * title: global - * description: The $ne's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $ne's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $ne's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $ne's lastindex. - * compile: - * type: object - * description: The $ne's compile. - * flags: - * type: string - * title: flags - * description: The $ne's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $ne's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $ne's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $ne's dotall. - * __@match@1165: - * type: object - * description: The $ne's @match@1165. - * __@replace@1167: - * type: object - * description: The $ne's @replace@1167. - * __@search@1170: - * type: object - * description: The $ne's @search@1170. - * __@split@1172: - * type: object - * description: The $ne's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $ne's @matchall@1174. + * type: string + * title: $ne * $in: * type: array * description: The updated at's $in. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $in's exec. - * test: - * type: object - * description: The $in's test. - * source: - * type: string - * title: source - * description: The $in's source. - * global: - * type: boolean - * title: global - * description: The $in's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $in's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $in's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $in's lastindex. - * compile: - * type: object - * description: The $in's compile. - * flags: - * type: string - * title: flags - * description: The $in's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $in's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $in's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $in's dotall. - * __@match@1165: - * type: object - * description: The $in's @match@1165. - * __@replace@1167: - * type: object - * description: The $in's @replace@1167. - * __@search@1170: - * type: object - * description: The $in's @search@1170. - * __@split@1172: - * type: object - * description: The $in's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $in's @matchall@1174. + * type: string + * title: $in * $nin: * type: array * description: The updated at's $nin. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * test: - * type: object - * description: The $nin's test. - * source: - * type: string - * title: source - * description: The $nin's source. - * global: - * type: boolean - * title: global - * description: The $nin's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $nin's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $nin's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $nin's lastindex. - * compile: - * type: object - * description: The $nin's compile. - * flags: - * type: string - * title: flags - * description: The $nin's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $nin's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $nin's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $nin's dotall. - * __@match@1165: - * type: object - * description: The $nin's @match@1165. - * __@replace@1167: - * type: object - * description: The $nin's @replace@1167. - * __@search@1170: - * type: object - * description: The $nin's @search@1170. - * __@split@1172: - * type: object - * description: The $nin's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $nin's @matchall@1174. + * type: string + * title: $nin * $not: * oneOf: * - type: string * title: $not - * description: The updated at's $not. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The updated at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1165: - * type: object - * description: The $not's @match@1165. - * __@replace@1167: - * type: object - * description: The $not's @replace@1167. - * __@search@1170: - * type: object - * description: The $not's @search@1170. - * __@split@1172: - * type: object - * description: The $not's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $not's @matchall@1174. - * - type: object - * description: The updated at's $not. + * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array * description: The $not's $and. * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp + * type: object + * title: $and * $or: * type: array * description: The $not's $or. * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp + * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp + * description: Filter by an exact match. * - type: array - * description: The $not's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The $not's $in. + * description: Filter by values in this array. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp + * type: string + * title: $in + * description: Filter by values in this array. * $nin: * type: array - * description: The $not's $nin. + * description: Filter by values not in this array. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp + * type: string + * title: $nin + * description: Filter by values not in this array. * $not: * oneOf: * - type: string * title: $not - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * - type: object - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp + * 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: The $not's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The $not's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The $not's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The $not's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The $not's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: Filter arrays that have overlapping values with this parameter. * $contains: * type: array - * description: The $not's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: Filter arrays that contain some of the values of this parameter. * $contained: * type: array - * description: The $not's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: Filter arrays that contain all values of this parameter. * $exists: * type: boolean * title: $exists - * description: The $not's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: The updated at's $not. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1165: - * type: object - * description: The $not's @match@1165. - * __@replace@1167: - * type: object - * description: The $not's @replace@1167. - * __@search@1170: - * type: object - * description: The $not's @search@1170. - * __@split@1172: - * type: object - * description: The $not's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $not's @matchall@1174. + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The updated at's $gt. - * - type: object - * description: The updated at's $gt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * test: - * type: object - * description: The $gt's test. - * source: - * type: string - * title: source - * description: The $gt's source. - * global: - * type: boolean - * title: global - * description: The $gt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gt's lastindex. - * compile: - * type: object - * description: The $gt's compile. - * flags: - * type: string - * title: flags - * description: The $gt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gt's dotall. - * __@match@1165: - * type: object - * description: The $gt's @match@1165. - * __@replace@1167: - * type: object - * description: The $gt's @replace@1167. - * __@search@1170: - * type: object - * description: The $gt's @search@1170. - * __@split@1172: - * type: object - * description: The $gt's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $gt's @matchall@1174. + * type: string + * title: $gt * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The updated at's $gte. - * - type: object - * description: The updated at's $gte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * test: - * type: object - * description: The $gte's test. - * source: - * type: string - * title: source - * description: The $gte's source. - * global: - * type: boolean - * title: global - * description: The $gte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gte's lastindex. - * compile: - * type: object - * description: The $gte's compile. - * flags: - * type: string - * title: flags - * description: The $gte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gte's dotall. - * __@match@1165: - * type: object - * description: The $gte's @match@1165. - * __@replace@1167: - * type: object - * description: The $gte's @replace@1167. - * __@search@1170: - * type: object - * description: The $gte's @search@1170. - * __@split@1172: - * type: object - * description: The $gte's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $gte's @matchall@1174. + * type: string + * title: $gte * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The updated at's $lt. - * - type: object - * description: The updated at's $lt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * test: - * type: object - * description: The $lt's test. - * source: - * type: string - * title: source - * description: The $lt's source. - * global: - * type: boolean - * title: global - * description: The $lt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lt's lastindex. - * compile: - * type: object - * description: The $lt's compile. - * flags: - * type: string - * title: flags - * description: The $lt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lt's dotall. - * __@match@1165: - * type: object - * description: The $lt's @match@1165. - * __@replace@1167: - * type: object - * description: The $lt's @replace@1167. - * __@search@1170: - * type: object - * description: The $lt's @search@1170. - * __@split@1172: - * type: object - * description: The $lt's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $lt's @matchall@1174. + * type: string + * title: $lt * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The updated at's $lte. - * - type: object - * description: The updated at's $lte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * test: - * type: object - * description: The $lte's test. - * source: - * type: string - * title: source - * description: The $lte's source. - * global: - * type: boolean - * title: global - * description: The $lte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lte's lastindex. - * compile: - * type: object - * description: The $lte's compile. - * flags: - * type: string - * title: flags - * description: The $lte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lte's dotall. - * __@match@1165: - * type: object - * description: The $lte's @match@1165. - * __@replace@1167: - * type: object - * description: The $lte's @replace@1167. - * __@search@1170: - * type: object - * description: The $lte's @search@1170. - * __@split@1172: - * type: object - * description: The $lte's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $lte's @matchall@1174. + * type: string + * title: $lte * $like: * type: string * title: $like @@ -4070,1883 +641,175 @@ * type: array * description: The deleted at's $and. * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1165: - * type: object - * description: The $and's @match@1165. - * __@replace@1167: - * type: object - * description: The $and's @replace@1167. - * __@search@1170: - * type: object - * description: The $and's @search@1170. - * __@split@1172: - * type: object - * description: The $and's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $and's @matchall@1174. - * - type: object - * description: The $and's details. - * properties: - * $and: - * type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $and's $or. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $and's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $and's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $and's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * - type: object - * description: The $and's $not. - * - type: array - * description: The $and's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $and's $like. - * $re: - * type: string - * title: $re - * description: The $and's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $and's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $and's $fulltext. - * $overlap: - * type: array - * description: The $and's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $and's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $and's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $and's $exists. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $and's exec. - * test: - * type: object - * description: The $and's test. - * source: - * type: string - * title: source - * description: The $and's source. - * global: - * type: boolean - * title: global - * description: The $and's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $and's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $and's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $and's lastindex. - * compile: - * type: object - * description: The $and's compile. - * flags: - * type: string - * title: flags - * description: The $and's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $and's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $and's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $and's dotall. - * __@match@1165: - * type: object - * description: The $and's @match@1165. - * __@replace@1167: - * type: object - * description: The $and's @replace@1167. - * __@search@1170: - * type: object - * description: The $and's @search@1170. - * __@split@1172: - * type: object - * description: The $and's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $and's @matchall@1174. + * type: object * $or: * type: array * description: The deleted at's $or. * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1165: - * type: object - * description: The $or's @match@1165. - * __@replace@1167: - * type: object - * description: The $or's @replace@1167. - * __@search@1170: - * type: object - * description: The $or's @search@1170. - * __@split@1172: - * type: object - * description: The $or's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $or's @matchall@1174. - * - type: object - * description: The $or's details. - * properties: - * $and: - * type: array - * description: The $or's $and. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * - type: array - * description: The $or's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The $or's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The $or's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * - type: object - * description: The $or's $not. - * - type: array - * description: The $or's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The $or's $like. - * $re: - * type: string - * title: $re - * description: The $or's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $or's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $or's $fulltext. - * $overlap: - * type: array - * description: The $or's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $or's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $or's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $or's $exists. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $or's exec. - * test: - * type: object - * description: The $or's test. - * source: - * type: string - * title: source - * description: The $or's source. - * global: - * type: boolean - * title: global - * description: The $or's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $or's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $or's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $or's lastindex. - * compile: - * type: object - * description: The $or's compile. - * flags: - * type: string - * title: flags - * description: The $or's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $or's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $or's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $or's dotall. - * __@match@1165: - * type: object - * description: The $or's @match@1165. - * __@replace@1167: - * type: object - * description: The $or's @replace@1167. - * __@search@1170: - * type: object - * description: The $or's @search@1170. - * __@split@1172: - * type: object - * description: The $or's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $or's @matchall@1174. + * type: object * $eq: * oneOf: * - type: string * title: $eq - * description: The deleted at's $eq. - * - type: object - * description: The deleted at's $eq. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1165: - * type: object - * description: The $eq's @match@1165. - * __@replace@1167: - * type: object - * description: The $eq's @replace@1167. - * __@search@1170: - * type: object - * description: The $eq's @search@1170. - * __@split@1172: - * type: object - * description: The $eq's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $eq's @matchall@1174. + * description: Filter by an exact match. * - type: array - * description: The deleted at's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * test: - * type: object - * description: The $eq's test. - * source: - * type: string - * title: source - * description: The $eq's source. - * global: - * type: boolean - * title: global - * description: The $eq's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $eq's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $eq's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $eq's lastindex. - * compile: - * type: object - * description: The $eq's compile. - * flags: - * type: string - * title: flags - * description: The $eq's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $eq's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $eq's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $eq's dotall. - * __@match@1165: - * type: object - * description: The $eq's @match@1165. - * __@replace@1167: - * type: object - * description: The $eq's @replace@1167. - * __@search@1170: - * type: object - * description: The $eq's @search@1170. - * __@split@1172: - * type: object - * description: The $eq's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $eq's @matchall@1174. + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The deleted at's $ne. - * - type: object - * description: The deleted at's $ne. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * test: - * type: object - * description: The $ne's test. - * source: - * type: string - * title: source - * description: The $ne's source. - * global: - * type: boolean - * title: global - * description: The $ne's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $ne's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $ne's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $ne's lastindex. - * compile: - * type: object - * description: The $ne's compile. - * flags: - * type: string - * title: flags - * description: The $ne's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $ne's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $ne's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $ne's dotall. - * __@match@1165: - * type: object - * description: The $ne's @match@1165. - * __@replace@1167: - * type: object - * description: The $ne's @replace@1167. - * __@search@1170: - * type: object - * description: The $ne's @search@1170. - * __@split@1172: - * type: object - * description: The $ne's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $ne's @matchall@1174. + * type: string + * title: $ne * $in: * type: array * description: The deleted at's $in. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $in's exec. - * test: - * type: object - * description: The $in's test. - * source: - * type: string - * title: source - * description: The $in's source. - * global: - * type: boolean - * title: global - * description: The $in's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $in's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $in's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $in's lastindex. - * compile: - * type: object - * description: The $in's compile. - * flags: - * type: string - * title: flags - * description: The $in's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $in's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $in's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $in's dotall. - * __@match@1165: - * type: object - * description: The $in's @match@1165. - * __@replace@1167: - * type: object - * description: The $in's @replace@1167. - * __@search@1170: - * type: object - * description: The $in's @search@1170. - * __@split@1172: - * type: object - * description: The $in's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $in's @matchall@1174. + * type: string + * title: $in * $nin: * type: array * description: The deleted at's $nin. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * test: - * type: object - * description: The $nin's test. - * source: - * type: string - * title: source - * description: The $nin's source. - * global: - * type: boolean - * title: global - * description: The $nin's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $nin's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $nin's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $nin's lastindex. - * compile: - * type: object - * description: The $nin's compile. - * flags: - * type: string - * title: flags - * description: The $nin's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $nin's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $nin's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $nin's dotall. - * __@match@1165: - * type: object - * description: The $nin's @match@1165. - * __@replace@1167: - * type: object - * description: The $nin's @replace@1167. - * __@search@1170: - * type: object - * description: The $nin's @search@1170. - * __@split@1172: - * type: object - * description: The $nin's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $nin's @matchall@1174. + * type: string + * title: $nin * $not: * oneOf: * - type: string * title: $not - * description: The deleted at's $not. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The deleted at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1165: - * type: object - * description: The $not's @match@1165. - * __@replace@1167: - * type: object - * description: The $not's @replace@1167. - * __@search@1170: - * type: object - * description: The $not's @search@1170. - * __@split@1172: - * type: object - * description: The $not's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $not's @matchall@1174. - * - type: object - * description: The deleted at's $not. + * description: Filter by values not matching the conditions in this parameter. * properties: * $and: * type: array * description: The $not's $and. * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp + * type: object + * title: $and * $or: * type: array * description: The $not's $or. * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp + * type: object + * title: $or * $eq: * oneOf: * - type: string * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp + * description: Filter by an exact match. * - type: array - * description: The $not's $eq. + * description: Filter by an exact match. * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp + * type: string + * title: $eq + * description: Filter by an exact match. * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. * $in: * type: array - * description: The $not's $in. + * description: Filter by values in this array. * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp + * type: string + * title: $in + * description: Filter by values in this array. * $nin: * type: array - * description: The $not's $nin. + * description: Filter by values not in this array. * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp + * type: string + * title: $nin + * description: Filter by values not in this array. * $not: * oneOf: * - type: string * title: $not - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * - type: object - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * - type: array - * description: The $not's details. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp + * 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: The $not's $like. + * description: Apply a `like` filter. Useful for strings only. * $re: * type: string * title: $re - * description: The $not's $re. + * description: Apply a regex filter. Useful for strings only. * $ilike: * type: string * title: $ilike - * description: The $not's $ilike. + * description: Apply a case-insensitive `like` filter. Useful for strings only. * $fulltext: * type: string * title: $fulltext - * description: The $not's $fulltext. + * description: Filter to apply on full-text properties. * $overlap: * type: array - * description: The $not's $overlap. + * description: Filter arrays that have overlapping values with this parameter. * items: * type: string * title: $overlap - * description: The $overlap's details. + * description: Filter arrays that have overlapping values with this parameter. * $contains: * type: array - * description: The $not's $contains. + * description: Filter arrays that contain some of the values of this parameter. * items: * type: string * title: $contains - * description: The $contain's $contains. + * description: Filter arrays that contain some of the values of this parameter. * $contained: * type: array - * description: The $not's $contained. + * description: Filter arrays that contain all values of this parameter. * items: * type: string * title: $contained - * description: The $contained's details. + * description: Filter arrays that contain all values of this parameter. * $exists: * type: boolean * title: $exists - * description: The $not's $exists. + * description: Filter by whether a value for this parameter exists (not `null`). * - type: array - * description: The deleted at's $not. + * description: Filter by values not matching the conditions in this parameter. * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $not's exec. - * test: - * type: object - * description: The $not's test. - * source: - * type: string - * title: source - * description: The $not's source. - * global: - * type: boolean - * title: global - * description: The $not's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $not's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $not's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $not's lastindex. - * compile: - * type: object - * description: The $not's compile. - * flags: - * type: string - * title: flags - * description: The $not's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $not's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $not's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $not's dotall. - * __@match@1165: - * type: object - * description: The $not's @match@1165. - * __@replace@1167: - * type: object - * description: The $not's @replace@1167. - * __@search@1170: - * type: object - * description: The $not's @search@1170. - * __@split@1172: - * type: object - * description: The $not's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $not's @matchall@1174. + * type: string + * title: $not + * description: Filter by values not matching the conditions in this parameter. * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The deleted at's $gt. - * - type: object - * description: The deleted at's $gt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * test: - * type: object - * description: The $gt's test. - * source: - * type: string - * title: source - * description: The $gt's source. - * global: - * type: boolean - * title: global - * description: The $gt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gt's lastindex. - * compile: - * type: object - * description: The $gt's compile. - * flags: - * type: string - * title: flags - * description: The $gt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gt's dotall. - * __@match@1165: - * type: object - * description: The $gt's @match@1165. - * __@replace@1167: - * type: object - * description: The $gt's @replace@1167. - * __@search@1170: - * type: object - * description: The $gt's @search@1170. - * __@split@1172: - * type: object - * description: The $gt's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $gt's @matchall@1174. + * type: string + * title: $gt * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The deleted at's $gte. - * - type: object - * description: The deleted at's $gte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * test: - * type: object - * description: The $gte's test. - * source: - * type: string - * title: source - * description: The $gte's source. - * global: - * type: boolean - * title: global - * description: The $gte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $gte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $gte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $gte's lastindex. - * compile: - * type: object - * description: The $gte's compile. - * flags: - * type: string - * title: flags - * description: The $gte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $gte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $gte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $gte's dotall. - * __@match@1165: - * type: object - * description: The $gte's @match@1165. - * __@replace@1167: - * type: object - * description: The $gte's @replace@1167. - * __@search@1170: - * type: object - * description: The $gte's @search@1170. - * __@split@1172: - * type: object - * description: The $gte's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $gte's @matchall@1174. + * type: string + * title: $gte * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The deleted at's $lt. - * - type: object - * description: The deleted at's $lt. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * test: - * type: object - * description: The $lt's test. - * source: - * type: string - * title: source - * description: The $lt's source. - * global: - * type: boolean - * title: global - * description: The $lt's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lt's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lt's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lt's lastindex. - * compile: - * type: object - * description: The $lt's compile. - * flags: - * type: string - * title: flags - * description: The $lt's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lt's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lt's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lt's dotall. - * __@match@1165: - * type: object - * description: The $lt's @match@1165. - * __@replace@1167: - * type: object - * description: The $lt's @replace@1167. - * __@search@1170: - * type: object - * description: The $lt's @search@1170. - * __@split@1172: - * type: object - * description: The $lt's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $lt's @matchall@1174. + * type: string + * title: $lt * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The deleted at's $lte. - * - type: object - * description: The deleted at's $lte. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@1165 - * - __@replace@1167 - * - __@search@1170 - * - __@matchAll@1174 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * test: - * type: object - * description: The $lte's test. - * source: - * type: string - * title: source - * description: The $lte's source. - * global: - * type: boolean - * title: global - * description: The $lte's global. - * ignoreCase: - * type: boolean - * title: ignoreCase - * description: The $lte's ignorecase. - * multiline: - * type: boolean - * title: multiline - * description: The $lte's multiline. - * lastIndex: - * type: number - * title: lastIndex - * description: The $lte's lastindex. - * compile: - * type: object - * description: The $lte's compile. - * flags: - * type: string - * title: flags - * description: The $lte's flags. - * sticky: - * type: boolean - * title: sticky - * description: The $lte's sticky. - * unicode: - * type: boolean - * title: unicode - * description: The $lte's unicode. - * dotAll: - * type: boolean - * title: dotAll - * description: The $lte's dotall. - * __@match@1165: - * type: object - * description: The $lte's @match@1165. - * __@replace@1167: - * type: object - * description: The $lte's @replace@1167. - * __@search@1170: - * type: object - * description: The $lte's @search@1170. - * __@split@1172: - * type: object - * description: The $lte's @split@1172. - * __@matchAll@1174: - * type: object - * description: The $lte's @matchall@1174. + * type: string + * title: $lte * $like: * type: string * title: $like @@ -6035,7 +898,8 @@ * oneOf: * - type: array * description: The $and's details. - * items: *a1 + * items: &a1 + * type: object * title: $and * - type: object * description: The $and's details. @@ -6060,7 +924,8 @@ * oneOf: * - type: array * description: The $or's details. - * items: *a2 + * items: &a2 + * type: object * title: $or * - type: object * description: The $or's details. diff --git a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts index 237f998fbd..693c4a4b31 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /store/products/{id} * operationId: GetProductsId * summary: Get a Product - * description: Retrieve a product by its ID. You can expand the product's - * relations or select the fields that should be returned. + * description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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: region_id * in: query * description: The product's region id. diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions.ts b/www/utils/generated/oas-output/operations/store/get_store_regions.ts index 09b66770a1..03ddaa5f73 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions.ts @@ -2,8 +2,7 @@ * @oas [get] /store/regions * operationId: GetRegions * summary: List Regions - * description: Retrieve a list of regions. The regions can be filtered by fields - * such as `id`. The regions can also be sorted or paginated. + * description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -16,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts index 91a8b570f2..a5a7d196ba 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /store/regions/{id} * operationId: GetRegionsId * summary: Get a Region - * description: Retrieve a region by its ID. You can expand the region's relations - * or select the fields that should be returned. + * description: Retrieve a region by its ID. You can expand the region's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts index 1f378d401d..766e9e6073 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts @@ -2,9 +2,7 @@ * @oas [get] /store/return-reasons * operationId: GetReturnReasons * summary: List Return Reasons - * description: Retrieve a list of return reasons. The return reasons can be - * filtered by fields such as `id`. The return reasons can also be sorted or - * paginated. + * description: Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts index fe255aec11..23c3bafab7 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts @@ -2,8 +2,7 @@ * @oas [get] /store/return-reasons/{id} * operationId: GetReturnReasonsId * summary: Get a Return Reason - * description: Retrieve a return reason by its ID. You can expand the return - * reason's relations or select the fields that should be returned. + * description: Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned. * x-authenticated: false * parameters: * - name: id @@ -22,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts index fac6680a69..08810f8a9c 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts @@ -2,9 +2,7 @@ * @oas [get] /store/shipping-options * operationId: GetShippingOptions * summary: List Shipping Options - * description: Retrieve a list of shipping options. The shipping options can be - * filtered by fields such as `id`. The shipping options can also be sorted or - * paginated. + * description: Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated. * x-authenticated: false * parameters: * - name: expand @@ -17,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts.ts b/www/utils/generated/oas-output/operations/store/post_store_carts.ts index 43cc0c4726..39888d99a5 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -66,9 +58,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts index 93d35ecfb2..b51ac6568a 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -72,9 +64,7 @@ * properties: * additional_data: * type: object - * description: Pass additional custom data to the API route. This data is passed - * to the underlying workflow under the `additional_data` - * parameter. + * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. * description: SUMMARY * x-codeSamples: * - lang: Shell @@ -107,6 +97,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCartWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts index adefa33fad..6c0ad10a34 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts index 6099cb3af2..c9e2046cfd 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -98,6 +90,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: addToCartWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts index 26c86cb598..17021ad255 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts @@ -27,18 +27,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -57,16 +53,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -103,6 +95,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateLineItemInCartWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts index 3de4d50123..0ec3ce5cbd 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -109,6 +101,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCartPromotionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts index 1cefa74bf5..28aa117b30 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -107,6 +99,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: addShippingMethodToWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts index b3b1c4ef2b..bd84aa0533 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -91,6 +83,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateTaxLinesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers.ts b/www/utils/generated/oas-output/operations/store/post_store_customers.ts index c466cc9345..29817bd5c7 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -94,6 +86,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createCustomerAccountWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts index 3ab4910cd4..68e00c6cba 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - cookie_auth: [] * - jwt_token: [] @@ -97,6 +89,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCustomersWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts index c431a54e7b..87e3239266 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - cookie_auth: [] * - jwt_token: [] @@ -175,6 +167,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createCustomerAddressesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts index 541eab73b9..e0eb0d0710 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * security: * - cookie_auth: [] * - jwt_token: [] @@ -181,6 +173,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: updateCustomerAddressesWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts index 4f25a674a0..c51d2f3661 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts @@ -15,18 +15,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +41,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -101,6 +93,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createPaymentCollectionForCartWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts index 71688a71e7..2144d2f31e 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts @@ -21,18 +21,14 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * required: false * schema: * type: string * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. + * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default + * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,16 +47,12 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * 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 - * `-`. + * 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 `-`. * required: false * schema: * 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 - * `-`. + * 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 `-`. * requestBody: * content: * application/json: @@ -83,12 +75,9 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/store/payment-collections/{id}/payment-sessions' \ - * + * source: |- + * curl -X POST '{backend_url}/store/payment-collections/{id}/payment-sessions' \ * -H 'Content-Type: application/json' \ - * * --data-raw '{ * "provider_id": "{value}" * }' @@ -113,6 +102,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createPaymentSessionsWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_return.ts b/www/utils/generated/oas-output/operations/store/post_store_return.ts index 5f94446090..6ffce3be6e 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_return.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_return.ts @@ -4,57 +4,7 @@ * summary: Create Return * description: Create a return. * x-authenticated: false - * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned - * data. if a field is prefixed with `+` it will be added to the default - * fields, using `-` will remove it from the default fields. without prefix - * it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * 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 - * `-`. - * required: false - * schema: - * 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 - * `-`. + * parameters: [] * requestBody: * content: * application/json: @@ -104,6 +54,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * x-workflow: createAndCompleteReturnOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/schemas/AdminApiKey.ts b/www/utils/generated/oas-output/schemas/AdminApiKey.ts new file mode 100644 index 0000000000..27f89441b9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminApiKey.ts @@ -0,0 +1,65 @@ +/** + * @schema AdminApiKey + * type: object + * description: The api key's details. + * x-schemaName: AdminApiKey + * required: + * - id + * - token + * - redacted + * - title + * - type + * - last_used_at + * - created_by + * - created_at + * - revoked_by + * - revoked_at + * properties: + * id: + * type: string + * title: id + * description: The api key's ID. + * token: + * type: string + * title: token + * description: The api key's token. + * redacted: + * type: string + * title: redacted + * description: The api key's redacted. + * title: + * type: string + * title: title + * description: The api key's title. + * type: + * type: string + * description: The api key's type. + * enum: + * - secret + * - publishable + * last_used_at: + * type: string + * title: last_used_at + * description: The api key's last used at. + * format: date-time + * created_by: + * type: string + * title: created_by + * description: The api key's created by. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The api key's created at. + * revoked_by: + * type: string + * title: revoked_by + * description: The api key's revoked by. + * revoked_at: + * type: string + * title: revoked_at + * description: The api key's revoked at. + * format: date-time + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts b/www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts index 7a4927d446..7c27bea828 100644 --- a/www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminApiKeyResponse.ts @@ -7,7 +7,7 @@ * - api_key * properties: * api_key: - * $ref: "#/components/schemas/ApiKeyResponse" + * $ref: "#/components/schemas/AdminApiKey" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminBatchProductResponse.ts b/www/utils/generated/oas-output/schemas/AdminBatchProductResponse.ts index 8fef743e96..2a33f5db4b 100644 --- a/www/utils/generated/oas-output/schemas/AdminBatchProductResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminBatchProductResponse.ts @@ -20,7 +20,7 @@ * $ref: "#/components/schemas/AdminProduct" * deleted: * type: object - * description: The product's deleted. + * description: SUMMARY * required: * - ids * - object @@ -36,11 +36,11 @@ * object: * type: string * title: object - * description: The deleted's object. + * description: SUMMARY * deleted: * type: boolean * title: deleted - * description: The deleted's details. + * description: SUMMARY * */ diff --git a/www/utils/generated/oas-output/schemas/AdminBatchProductVariantResponse.ts b/www/utils/generated/oas-output/schemas/AdminBatchProductVariantResponse.ts index 3be907982e..f8de696cdd 100644 --- a/www/utils/generated/oas-output/schemas/AdminBatchProductVariantResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminBatchProductVariantResponse.ts @@ -20,7 +20,7 @@ * $ref: "#/components/schemas/AdminProductVariant" * deleted: * type: object - * description: The product's deleted. + * description: SUMMARY * required: * - ids * - object @@ -36,11 +36,11 @@ * object: * type: string * title: object - * description: The deleted's object. + * description: SUMMARY * deleted: * type: boolean * title: deleted - * description: The deleted's details. + * description: SUMMARY * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCampaign.ts b/www/utils/generated/oas-output/schemas/AdminCampaign.ts new file mode 100644 index 0000000000..e6edc87f77 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCampaign.ts @@ -0,0 +1,78 @@ +/** + * @schema AdminCampaign + * type: object + * description: The campaign's details. + * x-schemaName: AdminCampaign + * required: + * - id + * - name + * - description + * - currency + * - campaign_identifier + * - starts_at + * - ends_at + * - budget + * properties: + * id: + * type: string + * title: id + * description: The campaign's ID. + * name: + * type: string + * title: name + * description: The campaign's name. + * description: + * type: string + * title: description + * description: The campaign's description. + * currency: + * type: string + * title: currency + * description: The campaign's currency. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - id + * - type + * - currency_code + * - limit + * - used + * properties: + * id: + * type: string + * title: id + * description: The budget's ID. + * type: + * type: string + * description: The budget's type. + * enum: + * - spend + * - usage + * currency_code: + * type: string + * title: currency_code + * description: The budget's currency code. + * limit: + * type: number + * title: limit + * description: The budget's limit. + * used: + * type: number + * title: used + * description: The budget's used. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts b/www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts index 20e33d8fcb..45d9d9a0fe 100644 --- a/www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminCampaignResponse.ts @@ -7,7 +7,7 @@ * - campaign * properties: * campaign: - * $ref: "#/components/schemas/CampaignResponse" + * $ref: "#/components/schemas/AdminCampaign" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminClaim.ts b/www/utils/generated/oas-output/schemas/AdminClaim.ts index aedcc95f41..d378b58fce 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaim.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaim.ts @@ -115,6 +115,7 @@ * $ref: "#/components/schemas/BasePaymentCollection" * payment_status: * type: string + * description: The claim's payment status. * enum: * - canceled * - not_paid @@ -133,6 +134,7 @@ * $ref: "#/components/schemas/BaseOrderFulfillment" * fulfillment_status: * type: string + * description: The claim's fulfillment status. * enum: * - canceled * - not_fulfilled diff --git a/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts index da42c81d2c..15a914ec17 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The claim's object. + * description: The name of the deleted object. * default: claim * deleted: * type: boolean * title: deleted - * description: The claim's deleted. + * description: Whether the Claim was deleted. * parent: * type: object * description: The claim's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts index 65e6ccb7e8..37762c2e15 100644 --- a/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminCollectionDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The collection's object. + * description: The name of the deleted object. * default: collection * deleted: * type: boolean * title: deleted - * description: The collection's deleted. + * description: Whether the Collection was deleted. * parent: * type: object * description: The collection's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminCreateApiKey.ts b/www/utils/generated/oas-output/schemas/AdminCreateApiKey.ts index b6634d1f26..954c20c188 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateApiKey.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateApiKey.ts @@ -13,6 +13,7 @@ * description: The api key's title. * type: * type: string + * description: The api key's type. * enum: * - publishable * - secret diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts index 261da8ee9c..6a0fab8381 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts @@ -27,11 +27,13 @@ * description: The price list's ends at. * status: * type: string + * description: The price list's status. * enum: * - active * - draft * type: * type: string + * description: The price list's type. * enum: * - sale * - override diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts index c061b4ecdf..35a0eeaaa4 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts @@ -49,6 +49,7 @@ * description: The create's handle. * status: * type: string + * description: The create's status. * enum: * - draft * - proposed diff --git a/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsAsyncResponse.ts b/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsAsyncResponse.ts index 73d8703e73..83fa47f841 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsAsyncResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsAsyncResponse.ts @@ -19,6 +19,7 @@ * compensate_input: {} * action: * type: string + * description: The workflows execution's action. * enum: * - invoke * - compensate diff --git a/www/utils/generated/oas-output/schemas/AdminExchange.ts b/www/utils/generated/oas-output/schemas/AdminExchange.ts index 8f9929e558..af248b4eeb 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchange.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchange.ts @@ -116,6 +116,7 @@ * $ref: "#/components/schemas/BasePaymentCollection" * payment_status: * type: string + * description: The exchange's payment status. * enum: * - canceled * - not_paid @@ -134,6 +135,7 @@ * $ref: "#/components/schemas/BaseOrderFulfillment" * fulfillment_status: * type: string + * description: The exchange's fulfillment status. * enum: * - canceled * - not_fulfilled diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts index 73637ed0fd..e8bc527e13 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The fulfillment set's object. + * description: The name of the deleted object. * default: fulfillment_set * deleted: * type: boolean * title: deleted - * description: The fulfillment set's deleted. + * description: Whether the Fulfillment Set was deleted. * parent: * type: object * description: The fulfillment set's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminInvite.ts b/www/utils/generated/oas-output/schemas/AdminInvite.ts index bd3d3ef00e..42dfa69fcf 100644 --- a/www/utils/generated/oas-output/schemas/AdminInvite.ts +++ b/www/utils/generated/oas-output/schemas/AdminInvite.ts @@ -36,14 +36,14 @@ * description: The invite's metadata. * created_at: * type: string + * format: date-time * title: created_at * description: The invite's created at. - * format: date-time * updated_at: * type: string + * format: date-time * title: updated_at * description: The invite's updated at. - * format: date-time * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts index b81a42bdd8..52f34d4294 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -102,6 +102,7 @@ * $ref: "#/components/schemas/BaseOrderShippingMethod" * payment_status: * type: string + * description: The order's payment status. * enum: * - canceled * - not_paid @@ -115,6 +116,7 @@ * - requires_action * fulfillment_status: * type: string + * description: The order's fulfillment status. * enum: * - canceled * - not_fulfilled diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts new file mode 100644 index 0000000000..c5245092f4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminOrderChangesResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminOrderChangesResponse + * required: + * - order_changes + * properties: + * order_changes: + * type: array + * description: The order's order changes. + * items: + * $ref: "#/components/schemas/BaseOrderChange" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts index 9931ba716e..2818d91362 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -202,14 +202,14 @@ * $ref: "#/components/schemas/BaseOrderItemDetail" * created_at: * type: string + * format: date-time * title: created_at * description: The item's created at. - * format: date-time * updated_at: * type: string + * format: date-time * title: updated_at * description: The item's updated at. - * format: date-time * metadata: * type: object * description: The item's metadata. @@ -507,6 +507,7 @@ * $ref: "#/components/schemas/AdminPaymentCollection" * payment_status: * type: string + * description: The order preview's payment status. * enum: * - canceled * - not_paid @@ -525,6 +526,7 @@ * $ref: "#/components/schemas/BaseOrderFulfillment" * fulfillment_status: * type: string + * description: The order preview's fulfillment status. * enum: * - canceled * - not_fulfilled diff --git a/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts b/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts index d6a3990f4c..0bd5d1e11d 100644 --- a/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts +++ b/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts @@ -95,6 +95,7 @@ * description: The payment collection's metadata. * status: * type: string + * description: The payment collection's status. * enum: * - canceled * - not_paid diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts index 19289f7008..2c9e6d3947 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimItemsReqSchema.ts @@ -24,6 +24,7 @@ * description: The item's quantity. * reason: * type: string + * description: The item's reason. * enum: * - missing_item * - wrong_item diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts index 714c77e5a0..da414d511c 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts @@ -11,6 +11,7 @@ * properties: * type: * type: string + * description: The claim's type. * enum: * - refund * - replace diff --git a/www/utils/generated/oas-output/schemas/AdminPriceList.ts b/www/utils/generated/oas-output/schemas/AdminPriceList.ts index c5c79b8848..a716e0b4c5 100644 --- a/www/utils/generated/oas-output/schemas/AdminPriceList.ts +++ b/www/utils/generated/oas-output/schemas/AdminPriceList.ts @@ -42,11 +42,13 @@ * description: The price list's ends at. * status: * type: string + * description: The price list's status. * enum: * - draft * - active * type: * type: string + * description: The price list's type. * enum: * - sale * - override diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts index c072f2c0e1..88aecfc4d7 100644 --- a/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts @@ -20,7 +20,7 @@ * $ref: "#/components/schemas/AdminPrice" * deleted: * type: object - * description: The price list's deleted. + * description: SUMMARY * required: * - ids * - object @@ -36,11 +36,11 @@ * object: * type: string * title: object - * description: The deleted's object. + * description: SUMMARY * deleted: * type: boolean * title: deleted - * description: The deleted's details. + * description: SUMMARY * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts index 86af71105b..f964ec8b00 100644 --- a/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminPriceListDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The price list's object. + * description: The name of the deleted object. * default: price_list * deleted: * type: boolean * title: deleted - * description: The price list's deleted. + * description: Whether the Price List was deleted. * parent: * type: object * description: The price list's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts index ab94d62720..d8468b2790 100644 --- a/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminPricePreferenceDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The price preference's object. + * description: The name of the deleted object. * default: price_preference * deleted: * type: boolean * title: deleted - * description: The price preference's deleted. + * description: Whether the Price Preference was deleted. * parent: * type: object * description: The price preference's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts index 01e8b0d573..63eb8a91fa 100644 --- a/www/utils/generated/oas-output/schemas/AdminProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -49,7 +49,7 @@ * items: * $ref: "#/components/schemas/AdminProductVariant" * type: - * $ref: "#/components/schemas/AdminProduct" + * $ref: "#/components/schemas/AdminProductType" * tags: * type: array * description: The parent's tags. @@ -61,6 +61,7 @@ * description: The parent's title. * status: * type: string + * description: The parent's status. * enum: * - draft * - proposed diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategory.ts b/www/utils/generated/oas-output/schemas/AdminProductCategory.ts index 7b5ebe0b75..48fcbc96b2 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductCategory.ts @@ -42,6 +42,9 @@ * type: string * title: id * description: The category's ID. + * metadata: + * type: object + * description: The category's metadata. * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts index 4d6c4dd957..30f442f47c 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductCategoryDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The product category's object. + * description: The name of the deleted object. * default: product_category * deleted: * type: boolean * title: deleted - * description: The product category's deleted. + * description: Whether the Product Category was deleted. * parent: * type: object * description: The product category's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts index 78dddd9dec..047cba8a74 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The product's object. + * description: The name of the deleted object. * default: product * deleted: * type: boolean * title: deleted - * description: The product's deleted. + * description: Whether the Product was deleted. * parent: * type: object * description: The product's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts index 8a49d3ce8f..601762d788 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The product's object. + * description: The name of the deleted object. * default: product_option * deleted: * type: boolean * title: deleted - * description: The product's deleted. + * description: Whether the Product was deleted. * parent: * $ref: "#/components/schemas/AdminProduct" * diff --git a/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts index 3d05f405de..28de610682 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductTagDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The product tag's object. + * description: The name of the deleted object. * default: product_tag * deleted: * type: boolean * title: deleted - * description: The product tag's deleted. + * description: Whether the Product Tag was deleted. * parent: * type: object * description: The product tag's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminProductType.ts b/www/utils/generated/oas-output/schemas/AdminProductType.ts new file mode 100644 index 0000000000..947c743dc0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductType.ts @@ -0,0 +1,40 @@ +/** + * @schema AdminProductType + * type: object + * description: The parent's type. + * x-schemaName: AdminProductType + * required: + * - id + * - value + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The type's ID. + * value: + * type: string + * title: value + * description: The type's value. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The type's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The type's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The type's deleted at. + * metadata: + * type: object + * description: The type's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts index 61a21e8e0b..25bc201c10 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductTypeDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The product type's object. + * description: The name of the deleted object. * default: product_type * deleted: * type: boolean * title: deleted - * description: The product type's deleted. + * description: Whether the Product Type was deleted. * parent: * type: object * description: The product type's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts index 2b67c1ca65..f3da2c7014 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductTypeListResponse.ts @@ -25,7 +25,7 @@ * type: array * description: The product type's product types. * items: - * $ref: "#/components/schemas/AdminProduct" + * $ref: "#/components/schemas/AdminProductType" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts index 41e1e92226..1111f5eaf2 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductTypeResponse.ts @@ -7,7 +7,7 @@ * - product_type * properties: * product_type: - * $ref: "#/components/schemas/AdminProduct" + * $ref: "#/components/schemas/AdminProductType" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts index 478ef4365e..31160a047f 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The product's object. + * description: The name of the deleted object. * default: variant * deleted: * type: boolean * title: deleted - * description: The product's deleted. + * description: Whether the Product was deleted. * parent: * $ref: "#/components/schemas/AdminProduct" * diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts index 9772ba0ced..7ccfe4bea1 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryBatchResponse.ts @@ -78,10 +78,10 @@ * oneOf: * - $ref: "#/components/schemas/AdminProductVariantInventoryLink" * - type: array - * description: The product's deleted. + * description: SUMMARY * items: * type: object - * description: The deleted's details. + * description: SUMMARY * x-schemaName: AdminProductVariantInventoryLink * required: * - productService diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts index a827a21163..9510ba6dd5 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts @@ -14,11 +14,11 @@ * object: * type: string * title: object - * description: The product's object. + * description: The name of the deleted object. * deleted: * type: boolean * title: deleted - * description: The product's deleted. + * description: Whether the Product was deleted. * parent: * $ref: "#/components/schemas/AdminProductVariant" * diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts index 28b3498d8b..fac8d344fa 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts @@ -64,20 +64,14 @@ * type: array * description: The variant's $and. * items: - * type: array - * description: The $and's details. - * items: - * type: object - * title: $and + * type: object + * title: $and * $or: * type: array * description: The variant's $or. * items: - * type: array - * description: The $or's details. - * items: - * type: object - * title: $or + * type: object + * title: $or * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPromotion.ts b/www/utils/generated/oas-output/schemas/AdminPromotion.ts index 484390bde9..679bb5aac3 100644 --- a/www/utils/generated/oas-output/schemas/AdminPromotion.ts +++ b/www/utils/generated/oas-output/schemas/AdminPromotion.ts @@ -16,6 +16,7 @@ * description: The promotion's code. * type: * type: string + * description: The promotion's type. * enum: * - standard * - buyget @@ -35,7 +36,7 @@ * title: campaign_id * description: The promotion's campaign id. * campaign: - * $ref: "#/components/schemas/CampaignResponse" + * $ref: "#/components/schemas/AdminCampaign" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts b/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts index 608c5dc845..b6dbb99f92 100644 --- a/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts +++ b/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts @@ -21,6 +21,7 @@ * description: The updated's attribute. * operator: * type: string + * description: The updated's operator. * enum: * - gt * - lt diff --git a/www/utils/generated/oas-output/schemas/AdminReservation.ts b/www/utils/generated/oas-output/schemas/AdminReservation.ts new file mode 100644 index 0000000000..6af38056bf --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminReservation.ts @@ -0,0 +1,71 @@ +/** + * @schema AdminReservation + * type: object + * description: The reservation's details. + * x-schemaName: AdminReservation + * required: + * - id + * - line_item_id + * - location_id + * - quantity + * - external_id + * - description + * - inventory_item_id + * - inventory_item + * properties: + * id: + * type: string + * title: id + * description: The reservation's ID. + * line_item_id: + * type: string + * title: line_item_id + * description: The reservation's line item id. + * location_id: + * type: string + * title: location_id + * description: The reservation's location id. + * quantity: + * type: string + * title: quantity + * description: The reservation's quantity. + * external_id: + * type: string + * title: external_id + * description: The reservation's external id. + * description: + * type: string + * title: description + * description: The reservation's description. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The reservation's inventory item id. + * inventory_item: + * type: object + * description: The reservation's inventory item. + * metadata: + * type: object + * description: The reservation's metadata. + * created_by: + * type: string + * title: created_by + * description: The reservation's created by. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The reservation's deleted at. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The reservation's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The reservation's updated at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminReservationResponse.ts b/www/utils/generated/oas-output/schemas/AdminReservationResponse.ts index 334c53328e..63106b86e9 100644 --- a/www/utils/generated/oas-output/schemas/AdminReservationResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminReservationResponse.ts @@ -7,7 +7,7 @@ * - reservation * properties: * reservation: - * $ref: "#/components/schemas/ReservationResponse" + * $ref: "#/components/schemas/AdminReservation" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminReturn.ts b/www/utils/generated/oas-output/schemas/AdminReturn.ts index f5f8c42fff..42859b6399 100644 --- a/www/utils/generated/oas-output/schemas/AdminReturn.ts +++ b/www/utils/generated/oas-output/schemas/AdminReturn.ts @@ -11,6 +11,7 @@ * - items * - received_at * - created_at + * - canceled_at * properties: * id: * type: string @@ -66,6 +67,10 @@ * format: date-time * title: created_at * description: The return's created at. + * canceled_at: + * type: string + * title: canceled_at + * description: The return's canceled at. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminReturnItem.ts b/www/utils/generated/oas-output/schemas/AdminReturnItem.ts index 6f04c950b4..dad068dd87 100644 --- a/www/utils/generated/oas-output/schemas/AdminReturnItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminReturnItem.ts @@ -7,6 +7,7 @@ * - id * - quantity * - received_quantity + * - damaged_quantity * - item_id * - return_id * properties: @@ -22,6 +23,10 @@ * type: number * title: received_quantity * description: The return item's received quantity. + * damaged_quantity: + * type: number + * title: damaged_quantity + * description: The return item's damaged quantity. * reason_id: * type: string * title: reason_id diff --git a/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts index e3e3e6c1b7..feaaa675ea 100644 --- a/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminSalesChannelDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The sales channel's object. + * description: The name of the deleted object. * default: sales-channel * deleted: * type: boolean * title: deleted - * description: The sales channel's deleted. + * description: Whether the Sales Channel was deleted. * parent: * type: object * description: The sales channel's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts index ab33eda9b8..6e423860cc 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The shipping option's object. + * description: The name of the deleted object. * default: shipping_option * deleted: * type: boolean * title: deleted - * description: The shipping option's deleted. + * description: Whether the Shipping Option was deleted. * parent: * type: object * description: The shipping option's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts index 7cc02e7b9a..570fc3e1a4 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The shipping profile's object. + * description: The name of the deleted object. * default: shipping_profile * deleted: * type: boolean * title: deleted - * description: The shipping profile's deleted. + * description: Whether the Shipping Profile was deleted. * parent: * type: object * description: The shipping profile's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts index bc4209551d..66aee30ea5 100644 --- a/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminStockLocationDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The stock location's object. + * description: The name of the deleted object. * default: stock_location * deleted: * type: boolean * title: deleted - * description: The stock location's deleted. + * description: Whether the Stock Location was deleted. * parent: * type: object * description: The stock location's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts index 060d0a1b88..2e82eddd96 100644 --- a/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminTaxRateDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The tax rate's object. + * description: The name of the deleted object. * default: tax_rate * deleted: * type: boolean * title: deleted - * description: The tax rate's deleted. + * description: Whether the Tax Rate was deleted. * parent: * type: object * description: The tax rate's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts index 1b2e446f72..31c4ec4736 100644 --- a/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminTaxRegionDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The tax region's object. + * description: The name of the deleted object. * default: tax_region * deleted: * type: boolean * title: deleted - * description: The tax region's deleted. + * description: Whether the Tax Region was deleted. * parent: * type: object * description: The tax region's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts index e5fc45c66c..b332d68fce 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts @@ -26,11 +26,13 @@ * description: The price list's ends at. * status: * type: string + * description: The price list's status. * enum: * - active * - draft * type: * type: string + * description: The price list's type. * enum: * - sale * - override diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts index 3cb22c68a4..086fe4d140 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts @@ -47,6 +47,7 @@ * description: The update's handle. * status: * type: string + * description: The update's status. * enum: * - draft * - proposed diff --git a/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts index 250e24c82a..ae11ddfbb9 100644 --- a/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminUserDeleteResponse.ts @@ -15,12 +15,12 @@ * object: * type: string * title: object - * description: The user's object. + * description: The name of the deleted object. * default: user * deleted: * type: boolean * title: deleted - * description: The user's deleted. + * description: Whether the User was deleted. * parent: * type: object * description: The user's parent. diff --git a/www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts b/www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts index 77765f24f2..7f98acce95 100644 --- a/www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts +++ b/www/utils/generated/oas-output/schemas/AdminWorkflowExecution.ts @@ -12,7 +12,6 @@ * - state * - created_at * - updated_at - * - deleted_at * properties: * id: * type: string @@ -27,29 +26,35 @@ * title: transaction_id * description: The workflow execution's transaction id. * execution: - * type: string - * title: execution - * description: The workflow execution's execution. + * $ref: "#/components/schemas/AdminWorkflowExecutionExecution" * context: + * $ref: "#/components/schemas/WorkflowExecutionContext" + * state: * type: string - * title: context - * description: The workflow execution's context. - * state: {} + * description: The workflow execution's state. + * enum: + * - not_started + * - invoking + * - waiting_to_compensate + * - compensating + * - done + * - reverted + * - failed * created_at: * type: string + * format: date-time * title: created_at * description: The workflow execution's created at. - * format: date-time * updated_at: * type: string + * format: date-time * title: updated_at * description: The workflow execution's updated at. - * format: date-time * deleted_at: * type: string + * format: date-time * title: deleted_at * description: The workflow execution's deleted at. - * format: date-time * */ diff --git a/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts b/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts new file mode 100644 index 0000000000..e72e06d9aa --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts @@ -0,0 +1,14 @@ +/** + * @schema AdminWorkflowExecutionExecution + * type: object + * description: The workflow execution's execution. + * x-schemaName: AdminWorkflowExecutionExecution + * required: + * - steps + * properties: + * steps: + * type: object + * description: The execution's steps. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts b/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts index 80acc3f30e..6b0acb7df7 100644 --- a/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts +++ b/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts @@ -12,17 +12,20 @@ * description: The application method's ID. * type: * type: string + * description: The application method's type. * enum: * - fixed * - percentage * target_type: * type: string + * description: The application method's target type. * enum: * - items * - shipping_methods * - order * allocation: * type: string + * description: The application method's allocation. * enum: * - each * - across diff --git a/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts b/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts index 7e63caa9d2..6018a5945c 100644 --- a/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseCartLineItem.ts @@ -161,19 +161,19 @@ * description: The item's metadata. * created_at: * type: string + * format: date-time * title: created_at * description: The item's created at. - * format: date-time * updated_at: * type: string + * format: date-time * title: updated_at * description: The item's updated at. - * format: date-time * deleted_at: * type: string + * format: date-time * title: deleted_at * description: The item's deleted at. - * format: date-time * original_total: * oneOf: * - type: string diff --git a/www/utils/generated/oas-output/schemas/BaseClaimItem.ts b/www/utils/generated/oas-output/schemas/BaseClaimItem.ts index 2152a3c648..ec6c773835 100644 --- a/www/utils/generated/oas-output/schemas/BaseClaimItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseClaimItem.ts @@ -34,6 +34,7 @@ * description: The claim item's quantity. * reason: * type: string + * description: The claim item's reason. * enum: * - missing_item * - wrong_item diff --git a/www/utils/generated/oas-output/schemas/BaseOrderChange.ts b/www/utils/generated/oas-output/schemas/BaseOrderChange.ts index 59abb06e69..aaeb705b11 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderChange.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderChange.ts @@ -121,6 +121,7 @@ * description: The order change's version. * change_type: * type: string + * description: The order change's change type. * enum: * - return * - exchange diff --git a/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts b/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts index f3dc63528f..cabb570a06 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts @@ -61,14 +61,14 @@ * description: The fulfillment's metadata. * created_at: * type: string + * format: date-time * title: created_at * description: The fulfillment's created at. - * format: date-time * updated_at: * type: string + * format: date-time * title: updated_at * description: The fulfillment's updated at. - * format: date-time * */ diff --git a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts index 779fce65e6..6f578ebd35 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts @@ -148,14 +148,14 @@ * $ref: "#/components/schemas/BaseOrderItemDetail" * created_at: * type: string + * format: date-time * title: created_at * description: The item's created at. - * format: date-time * updated_at: * type: string + * format: date-time * title: updated_at * description: The item's updated at. - * format: date-time * metadata: * type: object * description: The item's metadata. diff --git a/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts b/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts index b6bdcf8c73..bb1c1d15d6 100644 --- a/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts +++ b/www/utils/generated/oas-output/schemas/BasePaymentCollection.ts @@ -95,6 +95,7 @@ * description: The payment collection's metadata. * status: * type: string + * description: The payment collection's status. * enum: * - canceled * - not_paid diff --git a/www/utils/generated/oas-output/schemas/BaseProduct.ts b/www/utils/generated/oas-output/schemas/BaseProduct.ts index 6039481b0c..3765d42c13 100644 --- a/www/utils/generated/oas-output/schemas/BaseProduct.ts +++ b/www/utils/generated/oas-output/schemas/BaseProduct.ts @@ -57,6 +57,7 @@ * description: The product's is giftcard. * status: * type: string + * description: The product's status. * enum: * - draft * - proposed diff --git a/www/utils/generated/oas-output/schemas/BasePromotionRule.ts b/www/utils/generated/oas-output/schemas/BasePromotionRule.ts index 06ab02450b..5d8b4d5730 100644 --- a/www/utils/generated/oas-output/schemas/BasePromotionRule.ts +++ b/www/utils/generated/oas-output/schemas/BasePromotionRule.ts @@ -21,6 +21,7 @@ * description: The rule's attribute. * operator: * type: string + * description: The rule's operator. * enum: * - gt * - lt diff --git a/www/utils/generated/oas-output/schemas/OrderChange.ts b/www/utils/generated/oas-output/schemas/OrderChange.ts index 22db9178af..0a467e9cef 100644 --- a/www/utils/generated/oas-output/schemas/OrderChange.ts +++ b/www/utils/generated/oas-output/schemas/OrderChange.ts @@ -39,6 +39,7 @@ * description: The order change's version. * change_type: * type: string + * description: The order change's change type. * enum: * - return * - exchange diff --git a/www/utils/generated/oas-output/schemas/OrderPreview.ts b/www/utils/generated/oas-output/schemas/OrderPreview.ts index 0ffa49a165..185238c828 100644 --- a/www/utils/generated/oas-output/schemas/OrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/OrderPreview.ts @@ -214,14 +214,14 @@ * $ref: "#/components/schemas/OrderItem" * created_at: * type: string + * format: date-time * title: created_at * description: The item's created at. - * format: date-time * updated_at: * type: string + * format: date-time * title: updated_at * description: The item's updated at. - * format: date-time * metadata: * type: object * description: The item's metadata. @@ -661,6 +661,7 @@ * x-schemaName: OrderChangeAction * status: * type: string + * description: The order preview's status. * enum: * - canceled * - requires_action diff --git a/www/utils/generated/oas-output/schemas/StoreCartAddress.ts b/www/utils/generated/oas-output/schemas/StoreCartAddress.ts new file mode 100644 index 0000000000..40a384a435 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCartAddress.ts @@ -0,0 +1,82 @@ +/** + * @schema StoreCartAddress + * type: object + * description: The cart's billing address. + * x-schemaName: StoreCartAddress + * required: + * - id + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The billing address's ID. + * customer_id: + * type: string + * title: customer_id + * description: The billing address's customer id. + * first_name: + * type: string + * title: first_name + * description: The billing address's first name. + * last_name: + * type: string + * title: last_name + * description: The billing address's last name. + * phone: + * type: string + * title: phone + * description: The billing address's phone. + * company: + * type: string + * title: company + * description: The billing address's company. + * address_1: + * type: string + * title: address_1 + * description: The billing address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The billing address's address 2. + * city: + * type: string + * title: city + * description: The billing address's city. + * country_code: + * type: string + * title: country_code + * description: The billing address's country code. + * province: + * type: string + * title: province + * description: The billing address's province. + * postal_code: + * type: string + * title: postal_code + * description: The billing address's postal code. + * metadata: + * type: object + * description: The billing address's metadata. + * created_at: + * oneOf: + * - type: string + * title: created_at + * description: The billing address's created at. + * - type: string + * title: created_at + * description: The billing address's created at. + * format: date-time + * updated_at: + * oneOf: + * - type: string + * title: updated_at + * description: The billing address's updated at. + * - type: string + * title: updated_at + * description: The billing address's updated at. + * format: date-time + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts new file mode 100644 index 0000000000..90ab49c36c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts @@ -0,0 +1,311 @@ +/** + * @schema StoreCartLineItem + * type: object + * description: The item's items. + * x-schemaName: StoreCartLineItem + * required: + * - id + * - title + * - quantity + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - cart + * - cart_id + * - original_total + * - original_subtotal + * - original_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * title: + * type: string + * title: title + * description: The item's title. + * subtitle: + * type: string + * title: subtitle + * description: The item's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The item's thumbnail. + * quantity: + * oneOf: + * - type: string + * title: quantity + * description: The item's quantity. + * - type: number + * title: quantity + * description: The item's quantity. + * - type: string + * title: quantity + * description: The item's quantity. + * - $ref: "#/components/schemas/IBigNumber" + * product: + * $ref: "#/components/schemas/BaseProduct" + * product_id: + * type: string + * title: product_id + * description: The item's product id. + * product_title: + * type: string + * title: product_title + * description: The item's product title. + * product_description: + * type: string + * title: product_description + * description: The item's product description. + * product_subtitle: + * type: string + * title: product_subtitle + * description: The item's product subtitle. + * product_type: + * type: string + * title: product_type + * description: The item's product type. + * product_collection: + * type: string + * title: product_collection + * description: The item's product collection. + * product_handle: + * type: string + * title: product_handle + * description: The item's product handle. + * variant: + * $ref: "#/components/schemas/BaseProductVariant" + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * variant_sku: + * type: string + * title: variant_sku + * description: The item's variant sku. + * variant_barcode: + * type: string + * title: variant_barcode + * description: The item's variant barcode. + * variant_title: + * type: string + * title: variant_title + * description: The item's variant title. + * variant_option_values: + * type: object + * description: The item's variant option values. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The item's requires shipping. + * is_discountable: + * type: boolean + * title: is_discountable + * description: The item's is discountable. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The item's is tax inclusive. + * compare_at_unit_price: + * oneOf: + * - type: string + * title: compare_at_unit_price + * description: The item's compare at unit price. + * - type: number + * title: compare_at_unit_price + * description: The item's compare at unit price. + * - type: string + * title: compare_at_unit_price + * description: The item's compare at unit price. + * - $ref: "#/components/schemas/IBigNumber" + * unit_price: + * oneOf: + * - type: string + * title: unit_price + * description: The item's unit price. + * - type: number + * title: unit_price + * description: The item's unit price. + * - type: string + * title: unit_price + * description: The item's unit price. + * - $ref: "#/components/schemas/IBigNumber" + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * $ref: "#/components/schemas/BaseLineItemTaxLine" + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * $ref: "#/components/schemas/BaseLineItemAdjustment" + * cart: + * $ref: "#/components/schemas/BaseCart" + * cart_id: + * type: string + * title: cart_id + * description: The item's cart id. + * metadata: + * type: object + * description: The item's metadata. + * created_at: + * type: string + * title: created_at + * description: The item's created at. + * format: date-time + * updated_at: + * type: string + * title: updated_at + * description: The item's updated at. + * format: date-time + * deleted_at: + * type: string + * title: deleted_at + * description: The item's deleted at. + * format: date-time + * original_total: + * oneOf: + * - type: string + * title: original_total + * description: The item's original total. + * - type: number + * title: original_total + * description: The item's original total. + * - type: string + * title: original_total + * description: The item's original total. + * - $ref: "#/components/schemas/IBigNumber" + * original_subtotal: + * oneOf: + * - type: string + * title: original_subtotal + * description: The item's original subtotal. + * - type: number + * title: original_subtotal + * description: The item's original subtotal. + * - type: string + * title: original_subtotal + * description: The item's original subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * original_tax_total: + * oneOf: + * - type: string + * title: original_tax_total + * description: The item's original tax total. + * - type: number + * title: original_tax_total + * description: The item's original tax total. + * - type: string + * title: original_tax_total + * description: The item's original tax total. + * - $ref: "#/components/schemas/IBigNumber" + * item_total: + * oneOf: + * - type: string + * title: item_total + * description: The item's item total. + * - type: number + * title: item_total + * description: The item's item total. + * - type: string + * title: item_total + * description: The item's item total. + * - $ref: "#/components/schemas/IBigNumber" + * item_subtotal: + * oneOf: + * - type: string + * title: item_subtotal + * description: The item's item subtotal. + * - type: number + * title: item_subtotal + * description: The item's item subtotal. + * - type: string + * title: item_subtotal + * description: The item's item subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * item_tax_total: + * oneOf: + * - type: string + * title: item_tax_total + * description: The item's item tax total. + * - type: number + * title: item_tax_total + * description: The item's item tax total. + * - type: string + * title: item_tax_total + * description: The item's item tax total. + * - $ref: "#/components/schemas/IBigNumber" + * total: + * oneOf: + * - type: string + * title: total + * description: The item's total. + * - type: number + * title: total + * description: The item's total. + * - type: string + * title: total + * description: The item's total. + * - $ref: "#/components/schemas/IBigNumber" + * subtotal: + * oneOf: + * - type: string + * title: subtotal + * description: The item's subtotal. + * - type: number + * title: subtotal + * description: The item's subtotal. + * - type: string + * title: subtotal + * description: The item's subtotal. + * - $ref: "#/components/schemas/IBigNumber" + * tax_total: + * oneOf: + * - type: string + * title: tax_total + * description: The item's tax total. + * - type: number + * title: tax_total + * description: The item's tax total. + * - type: string + * title: tax_total + * description: The item's tax total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_total: + * oneOf: + * - type: string + * title: discount_total + * description: The item's discount total. + * - type: number + * title: discount_total + * description: The item's discount total. + * - type: string + * title: discount_total + * description: The item's discount total. + * - $ref: "#/components/schemas/IBigNumber" + * discount_tax_total: + * oneOf: + * - type: string + * title: discount_tax_total + * description: The item's discount tax total. + * - type: number + * title: discount_tax_total + * description: The item's discount tax total. + * - type: string + * title: discount_tax_total + * description: The item's discount tax total. + * - $ref: "#/components/schemas/IBigNumber" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreOrder.ts b/www/utils/generated/oas-output/schemas/StoreOrder.ts index 15f5361207..6527bcd730 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrder.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrder.ts @@ -96,6 +96,7 @@ * $ref: "#/components/schemas/BasePaymentCollection" * payment_status: * type: string + * description: The order's payment status. * enum: * - canceled * - not_paid @@ -114,6 +115,7 @@ * $ref: "#/components/schemas/BaseOrderFulfillment" * fulfillment_status: * type: string + * description: The order's fulfillment status. * enum: * - canceled * - not_fulfilled diff --git a/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts b/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts index ba304f848c..832c89d6ad 100644 --- a/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts +++ b/www/utils/generated/oas-output/schemas/StorePaymentCollection.ts @@ -95,6 +95,7 @@ * description: The payment collection's metadata. * status: * type: string + * description: The payment collection's status. * enum: * - canceled * - not_paid diff --git a/www/utils/generated/oas-output/schemas/StoreProduct.ts b/www/utils/generated/oas-output/schemas/StoreProduct.ts index 4e649b977a..5776be5150 100644 --- a/www/utils/generated/oas-output/schemas/StoreProduct.ts +++ b/www/utils/generated/oas-output/schemas/StoreProduct.ts @@ -44,6 +44,7 @@ * description: The product's title. * status: * type: string + * description: The product's status. * enum: * - draft * - proposed diff --git a/www/utils/generated/oas-output/schemas/StoreProductCategory.ts b/www/utils/generated/oas-output/schemas/StoreProductCategory.ts index ba6c8b39cb..f0fcede91e 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductCategory.ts @@ -62,6 +62,9 @@ * description: The category's category children. * items: * $ref: "#/components/schemas/BaseProductCategory" + * metadata: + * type: object + * description: The category's metadata. * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreReturn.ts b/www/utils/generated/oas-output/schemas/StoreReturn.ts index e0e54a0b4f..5949f039a7 100644 --- a/www/utils/generated/oas-output/schemas/StoreReturn.ts +++ b/www/utils/generated/oas-output/schemas/StoreReturn.ts @@ -11,6 +11,7 @@ * - items * - received_at * - created_at + * - canceled_at * properties: * id: * type: string @@ -66,6 +67,10 @@ * format: date-time * title: created_at * description: The return's created at. + * canceled_at: + * type: string + * title: canceled_at + * description: The return's canceled at. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreShippingOption.ts b/www/utils/generated/oas-output/schemas/StoreShippingOption.ts index 7837a493c1..f95e60a3c5 100644 --- a/www/utils/generated/oas-output/schemas/StoreShippingOption.ts +++ b/www/utils/generated/oas-output/schemas/StoreShippingOption.ts @@ -28,6 +28,7 @@ * description: The shipping option's name. * price_type: * type: string + * description: The shipping option's price type. * enum: * - flat * - calculated diff --git a/www/utils/generated/oas-output/schemas/WorkflowExecutionContext.ts b/www/utils/generated/oas-output/schemas/WorkflowExecutionContext.ts new file mode 100644 index 0000000000..ebd651f2b8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/WorkflowExecutionContext.ts @@ -0,0 +1,24 @@ +/** + * @schema WorkflowExecutionContext + * type: object + * description: The workflow execution's context. + * x-schemaName: WorkflowExecutionContext + * required: + * - compensate + * - errors + * properties: + * data: + * type: object + * description: The context's data. + * compensate: + * type: object + * description: The context's compensate. + * errors: + * type: array + * description: The context's errors. + * items: + * type: object + * description: The error's errors. + * +*/ +