diff --git a/docs-util/oas-output/base-v2/admin.oas.base.yaml b/docs-util/oas-output/base-v2/admin.oas.base.yaml index 739af3159a..f0537f2e5c 100644 --- a/docs-util/oas-output/base-v2/admin.oas.base.yaml +++ b/docs-util/oas-output/base-v2/admin.oas.base.yaml @@ -34,7 +34,10 @@ tags: externalDocs: description: How to manage customers url: https://docs.medusajs.com/modules/customers/admin/manage-customers - - name: Fulfillment + - name: Draft Orders + - name: Fulfillment Providers + - name: Fulfillment Sets + - name: Fulfillments - name: Inventory Items description: > Inventory items, provided by the [Inventory @@ -50,6 +53,7 @@ tags: externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + - name: Orders - name: Payments description: > A payment can be related to an order, swap, return, or more. It can be @@ -62,6 +66,8 @@ tags: description: How to manage price lists url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists - name: Pricing + - name: Product Categories + - name: Product Types - name: Products description: > Products are saleable items in a store. This also includes [saleable gift @@ -80,6 +86,7 @@ tags: externalDocs: description: How to manage regions url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions + - name: Reservations - name: Sales Channels description: > A sales channel indicates a channel where products can be sold in. For @@ -89,6 +96,8 @@ tags: externalDocs: description: How to manage sales channels url: https://docs.medusajs.com/modules/sales-channels/admin/manage + - name: Shipping Options + - name: Shipping Profiles - name: Stock Locations - name: Stores - name: Tax Rates @@ -100,6 +109,7 @@ tags: description: How to manage tax rates url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates - name: Tax Regions + - name: Uploads - name: Users description: > A store can have more than one user, each having the same privileges. diff --git a/docs-util/oas-output/base-v2/store.oas.base.yaml b/docs-util/oas-output/base-v2/store.oas.base.yaml index 8403c4fcf2..cdc8dde7e2 100644 --- a/docs-util/oas-output/base-v2/store.oas.base.yaml +++ b/docs-util/oas-output/base-v2/store.oas.base.yaml @@ -15,6 +15,7 @@ tags: externalDocs: description: How to implement cart functionality in your storefront url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart + - name: Collections - name: Currencies - name: Customers description: > @@ -27,6 +28,8 @@ tags: description: > A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + - name: Product Categories + - name: Products - name: Regions description: > Regions are different countries or geographical regions that the commerce diff --git a/docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts index 3abdbe40f0..16a00b29e0 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts index 748cbad169..e819d2a161 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts index 780f80274e..e5576fdd03 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts index d031227e90..74d1c1bbdc 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts index aecb556896..a507565038 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index 27de00a927..f082a72520 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts new file mode 100644 index 0000000000..5c52e60448 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/fulfillment-sets/{id} + * operationId: DeleteFulfillmentSetsId + * summary: Delete a Fulfillment Set + * description: Delete a fulfillment set. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment set's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Fulfillment Sets + * 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/docs-util/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/docs-util/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts new file mode 100644 index 0000000000..b9a82b4991 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -0,0 +1,53 @@ +/** + * @oas [delete] /admin/fulfillment-sets/{id}/service-zones/{zone_id} + * 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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment set's ID. + * required: true + * schema: + * type: string + * - name: zone_id + * in: path + * description: The fulfillment set's zone id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * 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}' + * tags: + * - Fulfillment Sets + * 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/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts index 2fb2fe4f4b..9b1c4c1c26 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts b/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts index 37627f876c..5a922ceab1 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -19,46 +19,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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts index c28fa95452..f213fe6102 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts index 9eaf720154..9ca537248f 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts index f3b761c0be..5938f43223 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -60,7 +20,8 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq" + * description: SUMMARY + * properties: {} * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/delete_admin_product-types_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_product-types_[id].ts new file mode 100644 index 0000000000..cb4790be5c --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_product-types_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/product-types/{id} + * operationId: DeleteProductTypesId + * summary: Delete a Product Type + * description: Delete a product type. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product type's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/product-types/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Product Types + * 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/docs-util/oas-output/operations/admin/delete_admin_products_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_products_[id].ts index 9bcdf2ac54..77e0a76a17 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_products_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_products_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts b/docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts index 6bda250d2c..901e3cfa80 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts b/docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts index 5b8a73b64c..c0f8eb20f8 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts index 5a869ae239..9fd5f5565a 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts index c2bd70fb29..55223c1504 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_reservations_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_reservations_[id].ts new file mode 100644 index 0000000000..4cd29a8f88 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_reservations_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/reservations/{id} + * operationId: DeleteReservationsId + * summary: Delete a Reservation + * description: Delete a reservation. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The reservation's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/reservations/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Reservations + * 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/docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts index f1aec0491a..10f081f541 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_shipping-options_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_shipping-options_[id].ts new file mode 100644 index 0000000000..a10d9a6d94 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_shipping-options_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/shipping-options/{id} + * operationId: DeleteShippingOptionsId + * summary: Delete a Shipping Option + * description: Delete a shipping option. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The shipping option's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/shipping-options/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Shipping Options + * 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/docs-util/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts new file mode 100644 index 0000000000..5b9d089ee7 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/shipping-profiles/{id} + * operationId: DeleteShippingProfilesId + * summary: Delete a Shipping Profile + * description: Delete a shipping profile. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The shipping profile's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/shipping-profiles/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Shipping Profiles + * 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/docs-util/oas-output/operations/admin/delete_admin_stock-locations_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_stock-locations_[id].ts index 75d1805085..6c3f9dc9c5 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_stock-locations_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_stock-locations_[id].ts @@ -24,8 +24,6 @@ * tags: * - Stock Locations * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -38,6 +36,10 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * requestBody: + * content: + * application/json: + * schema: {} * */ diff --git a/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts index 88e55f1ffc..6f2623172e 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts b/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts index 7a9b3cf518..89ed667566 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts index 6167b913fe..82f0138bce 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/delete_admin_uploads_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_uploads_[id].ts new file mode 100644 index 0000000000..008f12eb53 --- /dev/null +++ b/docs-util/oas-output/operations/admin/delete_admin_uploads_[id].ts @@ -0,0 +1,43 @@ +/** + * @oas [delete] /admin/uploads/{id} + * operationId: DeleteUploadsId + * summary: Delete a Upload + * description: Delete a upload. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The upload's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/uploads/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Uploads + * 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/docs-util/oas-output/operations/admin/delete_admin_users_[id].ts b/docs-util/oas-output/operations/admin/delete_admin_users_[id].ts index 3eab291d9b..ef8c38acac 100644 --- a/docs-util/oas-output/operations/admin/delete_admin_users_[id].ts +++ b/docs-util/oas-output/operations/admin/delete_admin_users_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_api-keys.ts b/docs-util/oas-output/operations/admin/get_admin_api-keys.ts index b0fe3c6a6a..0a4b69a1ca 100644 --- a/docs-util/oas-output/operations/admin/get_admin_api-keys.ts +++ b/docs-util/oas-output/operations/admin/get_admin_api-keys.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts b/docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts index 1273ff70f8..37117f453c 100644 --- a/docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_campaigns.ts b/docs-util/oas-output/operations/admin/get_admin_campaigns.ts index eb8477dea9..b6fa13bc0c 100644 --- a/docs-util/oas-output/operations/admin/get_admin_campaigns.ts +++ b/docs-util/oas-output/operations/admin/get_admin_campaigns.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts b/docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts index 29681ce0fe..107b429f67 100644 --- a/docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_collections.ts b/docs-util/oas-output/operations/admin/get_admin_collections.ts index dd74996472..c8889059f1 100644 --- a/docs-util/oas-output/operations/admin/get_admin_collections.ts +++ b/docs-util/oas-output/operations/admin/get_admin_collections.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_collections_[id].ts b/docs-util/oas-output/operations/admin/get_admin_collections_[id].ts index b885d1c610..6da5e1c698 100644 --- a/docs-util/oas-output/operations/admin/get_admin_collections_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_collections_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_currencies.ts b/docs-util/oas-output/operations/admin/get_admin_currencies.ts index 24e1e5446c..9e7121625a 100644 --- a/docs-util/oas-output/operations/admin/get_admin_currencies.ts +++ b/docs-util/oas-output/operations/admin/get_admin_currencies.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts b/docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts index 3dfee69a65..fb9d834671 100644 --- a/docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts +++ b/docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_customer-groups.ts b/docs-util/oas-output/operations/admin/get_admin_customer-groups.ts index 9d94241929..5d51bb8b4a 100644 --- a/docs-util/oas-output/operations/admin/get_admin_customer-groups.ts +++ b/docs-util/oas-output/operations/admin/get_admin_customer-groups.ts @@ -6,47 +6,7 @@ * filtered by fields such as `id`. The customer groups can also be sorted or * paginated. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts b/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts index fa88b8d527..43446f72c7 100644 --- a/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id]_customers.ts b/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id]_customers.ts deleted file mode 100644 index 36390ac456..0000000000 --- a/docs-util/oas-output/operations/admin/get_admin_customer-groups_[id]_customers.ts +++ /dev/null @@ -1,86 +0,0 @@ -/** - * @oas [get] /admin/customer-groups/{id}/customers - * operationId: GetCustomerGroupsIdCustomers - * summary: List Customers - * description: Retrieve a list of customers in a customer group. The customers can - * be filtered by fields like FILTER FIELDS. The customers can also be paginated. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The customer group'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl '{backend_url}/admin/customer-groups/{id}/customers' \ - * -H 'x-medusa-access-token: {api_token}' - * tags: - * - Customer Groups - * responses: - * "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" - * requestBody: - * content: - * application/json: - * schema: {} - * -*/ - diff --git a/docs-util/oas-output/operations/admin/get_admin_customers.ts b/docs-util/oas-output/operations/admin/get_admin_customers.ts index 7fe53add56..4931497333 100644 --- a/docs-util/oas-output/operations/admin/get_admin_customers.ts +++ b/docs-util/oas-output/operations/admin/get_admin_customers.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +19,11 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: {} * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/docs-util/oas-output/operations/admin/get_admin_customers_[id].ts b/docs-util/oas-output/operations/admin/get_admin_customers_[id].ts index 0570225280..641c7e3fa9 100644 --- a/docs-util/oas-output/operations/admin/get_admin_customers_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_customers_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +25,11 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: {} * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index 6e4505a91b..5c546cbfc4 100644 --- a/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts index a49b2b2fbb..43f7354296 100644 --- a/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_draft-orders.ts b/docs-util/oas-output/operations/admin/get_admin_draft-orders.ts new file mode 100644 index 0000000000..070c0cfc0e --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_draft-orders.ts @@ -0,0 +1,38 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/draft-orders' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Draft Orders + * 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/docs-util/oas-output/operations/admin/get_admin_draft-orders_[id].ts b/docs-util/oas-output/operations/admin/get_admin_draft-orders_[id].ts new file mode 100644 index 0000000000..7f7a74ae40 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_draft-orders_[id].ts @@ -0,0 +1,44 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The draft order's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/draft-orders/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Draft Orders + * 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/docs-util/oas-output/operations/admin/get_admin_fulfillment-providers.ts b/docs-util/oas-output/operations/admin/get_admin_fulfillment-providers.ts new file mode 100644 index 0000000000..521f35ef5f --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_fulfillment-providers.ts @@ -0,0 +1,56 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The fulfillment provider's fields. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/fulfillment-providers' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "fields": "{value}" + * }' + * tags: + * - Fulfillment Providers + * 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/docs-util/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/docs-util/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts new file mode 100644 index 0000000000..a35598b99d --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -0,0 +1,51 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment set's ID. + * required: true + * schema: + * type: string + * - name: zone_id + * in: path + * description: The fulfillment set's zone id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Fulfillment Sets + * 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/docs-util/oas-output/operations/admin/get_admin_inventory-items.ts b/docs-util/oas-output/operations/admin/get_admin_inventory-items.ts index 0bb021c6c9..eb19918c52 100644 --- a/docs-util/oas-output/operations/admin/get_admin_inventory-items.ts +++ b/docs-util/oas-output/operations/admin/get_admin_inventory-items.ts @@ -6,47 +6,7 @@ * filtered by fields such as `id`. The inventory items can also be sorted or * paginated. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts b/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts index 654033011c..d64c193fdf 100644 --- a/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -80,7 +40,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The inventory item's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts new file mode 100644 index 0000000000..2bfc44912d --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts @@ -0,0 +1,45 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The inventory item's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/inventory-items/{id}/location-levels' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Inventory Items + * 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/docs-util/oas-output/operations/admin/get_admin_invites.ts b/docs-util/oas-output/operations/admin/get_admin_invites.ts index f6f54520f2..94bc76cc86 100644 --- a/docs-util/oas-output/operations/admin/get_admin_invites.ts +++ b/docs-util/oas-output/operations/admin/get_admin_invites.ts @@ -5,47 +5,7 @@ * 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: 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_invites_[id].ts b/docs-util/oas-output/operations/admin/get_admin_invites_[id].ts index 8dc7f82de4..6aa03beebc 100644 --- a/docs-util/oas-output/operations/admin/get_admin_invites_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_invites_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_orders.ts b/docs-util/oas-output/operations/admin/get_admin_orders.ts new file mode 100644 index 0000000000..8de594a03a --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_orders.ts @@ -0,0 +1,38 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/orders' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Orders + * 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/docs-util/oas-output/operations/admin/get_admin_orders_[id].ts b/docs-util/oas-output/operations/admin/get_admin_orders_[id].ts new file mode 100644 index 0000000000..e7ea40aff2 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_orders_[id].ts @@ -0,0 +1,44 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/orders/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Orders + * 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/docs-util/oas-output/operations/admin/get_admin_payments.ts b/docs-util/oas-output/operations/admin/get_admin_payments.ts index 428310573d..6850fc66d1 100644 --- a/docs-util/oas-output/operations/admin/get_admin_payments.ts +++ b/docs-util/oas-output/operations/admin/get_admin_payments.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_payments_[id].ts b/docs-util/oas-output/operations/admin/get_admin_payments_[id].ts index cec4ce646a..2cdae025a6 100644 --- a/docs-util/oas-output/operations/admin/get_admin_payments_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_payments_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -80,7 +40,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The payment's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_payments_payment-providers.ts b/docs-util/oas-output/operations/admin/get_admin_payments_payment-providers.ts new file mode 100644 index 0000000000..97c3fd4921 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_payments_payment-providers.ts @@ -0,0 +1,38 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/payments/payment-providers' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Payments + * 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/docs-util/oas-output/operations/admin/get_admin_price-lists.ts b/docs-util/oas-output/operations/admin/get_admin_price-lists.ts index 2f879f3d89..2c5d55e144 100644 --- a/docs-util/oas-output/operations/admin/get_admin_price-lists.ts +++ b/docs-util/oas-output/operations/admin/get_admin_price-lists.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts b/docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts index 35a90b52df..dbffb07694 100644 --- a/docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts b/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts index 0624f422c4..cfabd3b4fd 100644 --- a/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts +++ b/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts @@ -5,47 +5,7 @@ * description: Retrieve a list of pricing. The pricing can be filtered by fields * such as `id`. The pricing can also be sorted or paginated. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -54,7 +14,35 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminGetPricingRuleTypesParams" + * description: SUMMARY + * properties: + * rule_attribute: + * type: array + * description: The pricing's rule attribute. + * items: + * type: string + * title: rule_attribute + * description: The rule attribute's details. + * expand: + * type: string + * title: expand + * description: The pricing's expand. + * fields: + * type: string + * title: fields + * description: The pricing's fields. + * offset: + * type: number + * title: offset + * description: The pricing's offset. + * limit: + * type: number + * title: limit + * description: The pricing's limit. + * order: + * type: string + * title: order + * description: The pricing's order. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts b/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts index 05f66e3ee2..bad6c345b9 100644 --- a/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -60,7 +20,15 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminGetPricingRuleTypesRuleTypeParams" + * type: object + * description: SUMMARY + * properties: + * fields: + * type: string + * title: fields + * description: The pricing's fields. + * required: + * - fields * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/get_admin_product-categories.ts b/docs-util/oas-output/operations/admin/get_admin_product-categories.ts new file mode 100644 index 0000000000..de2aa50b5d --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_product-categories.ts @@ -0,0 +1,39 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/product-categories' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Product Categories + * 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/docs-util/oas-output/operations/admin/get_admin_product-categories_[id].ts b/docs-util/oas-output/operations/admin/get_admin_product-categories_[id].ts new file mode 100644 index 0000000000..5fd8a55c70 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_product-categories_[id].ts @@ -0,0 +1,73 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product category's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - fields + * - include_ancestors_tree + * - include_descendants_tree + * properties: + * fields: + * type: string + * title: fields + * description: The product category's fields. + * include_ancestors_tree: + * type: boolean + * title: include_ancestors_tree + * description: The product category's include ancestors tree. + * include_descendants_tree: + * type: boolean + * title: include_descendants_tree + * description: The product category's include descendants tree. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/product-categories/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "fields": "{value}", + * "include_ancestors_tree": true, + * "include_descendants_tree": true + * }' + * tags: + * - Product Categories + * 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/docs-util/oas-output/operations/admin/get_admin_product-types.ts b/docs-util/oas-output/operations/admin/get_admin_product-types.ts new file mode 100644 index 0000000000..5ace375ef1 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_product-types.ts @@ -0,0 +1,38 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/product-types' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Product Types + * 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/docs-util/oas-output/operations/admin/get_admin_product-types_[id].ts b/docs-util/oas-output/operations/admin/get_admin_product-types_[id].ts new file mode 100644 index 0000000000..4e2d79fd2c --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_product-types_[id].ts @@ -0,0 +1,61 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product type's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The product type's fields. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/product-types/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "fields": "{value}" + * }' + * tags: + * - Product Types + * 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/docs-util/oas-output/operations/admin/get_admin_products.ts b/docs-util/oas-output/operations/admin/get_admin_products.ts index a0f291683c..1f89ad0405 100644 --- a/docs-util/oas-output/operations/admin/get_admin_products.ts +++ b/docs-util/oas-output/operations/admin/get_admin_products.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -54,7 +14,8346 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminGetProductsParams" + * description: SUMMARY + * properties: + * q: + * type: string + * title: q + * description: The product's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The product's ID. + * - type: array + * description: The product's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The product's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * title: + * type: string + * title: title + * description: The product's title. + * handle: + * type: string + * title: handle + * description: The product's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * price_list_id: + * type: array + * description: The product's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * sales_channel_id: + * type: array + * description: The product's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * collection_id: + * type: array + * description: The product's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The product's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The product's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The product's variants. + * properties: {} + * created_at: + * type: object + * description: The product's created at. + * properties: + * $and: + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $and's exec. + * properties: {} + * test: + * type: object + * description: The $and's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $and's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $and's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $and's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $and's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $and's @matchall@2360. + * properties: {} + * - 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * properties: {} + * - 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 + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $and's $not. + * properties: {} + * - 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 + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $and's exec. + * properties: {} + * test: + * type: object + * description: The $and's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $and's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $and's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $and's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $and's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $and's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $or's exec. + * properties: {} + * test: + * type: object + * description: The $or's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $or's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $or's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $or's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $or's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $or's @matchall@2360. + * properties: {} + * - 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * properties: {} + * - 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 + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $or's $not. + * properties: {} + * - 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 + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $or's exec. + * properties: {} + * test: + * type: object + * description: The $or's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $or's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $or's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $or's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $or's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $or's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * properties: {} + * test: + * type: object + * description: The $eq's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $eq's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $eq's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $eq's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $eq's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $eq's @matchall@2360. + * properties: {} + * - type: array + * description: The created at's $eq. + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * properties: {} + * test: + * type: object + * description: The $eq's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $eq's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $eq's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $eq's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $eq's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $eq's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * properties: {} + * test: + * type: object + * description: The $ne's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $ne's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $ne's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $ne's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $ne's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $ne's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $in's exec. + * properties: {} + * test: + * type: object + * description: The $in's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $in's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $in's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $in's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $in's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $in's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * properties: {} + * test: + * type: object + * description: The $nin's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $nin's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $nin's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $nin's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $nin's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $nin's @matchall@2360. + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The created at's $not. + * - type: object + * description: The created at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $not's exec. + * properties: {} + * test: + * type: object + * description: The $not's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $not's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $not's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $not's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $not's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $not's @matchall@2360. + * properties: {} + * - type: object + * description: The created at's $not. + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * properties: {} + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * properties: {} + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $not's details. + * properties: {} + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The created at's $not. + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $not's exec. + * properties: {} + * test: + * type: object + * description: The $not's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $not's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $not's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $not's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $not's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $not's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * properties: {} + * test: + * type: object + * description: The $gt's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $gt's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $gt's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $gt's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $gt's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $gt's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * properties: {} + * test: + * type: object + * description: The $gte's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $gte's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $gte's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $gte's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $gte's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $gte's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * properties: {} + * test: + * type: object + * description: The $lt's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $lt's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $lt's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $lt's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $lt's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $lt's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * properties: {} + * test: + * type: object + * description: The $lte's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $lte's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $lte's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $lte's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $lte's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $lte's @matchall@2360. + * properties: {} + * $like: + * type: string + * title: $like + * description: The created at's $like. + * $re: + * type: string + * title: $re + * description: The created at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The created at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The created at's $fulltext. + * $overlap: + * type: array + * description: The created at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The created at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The created at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The created at's $exists. + * updated_at: + * type: object + * description: The product's updated at. + * properties: + * $and: + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $and's exec. + * properties: {} + * test: + * type: object + * description: The $and's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $and's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $and's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $and's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $and's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $and's @matchall@2360. + * properties: {} + * - 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * properties: {} + * - 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 + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $and's $not. + * properties: {} + * - 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 + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $and's exec. + * properties: {} + * test: + * type: object + * description: The $and's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $and's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $and's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $and's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $and's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $and's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $or's exec. + * properties: {} + * test: + * type: object + * description: The $or's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $or's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $or's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $or's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $or's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $or's @matchall@2360. + * properties: {} + * - 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * properties: {} + * - 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 + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $or's $not. + * properties: {} + * - 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 + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $or's exec. + * properties: {} + * test: + * type: object + * description: The $or's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $or's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $or's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $or's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $or's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $or's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * properties: {} + * test: + * type: object + * description: The $eq's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $eq's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $eq's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $eq's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $eq's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $eq's @matchall@2360. + * properties: {} + * - type: array + * description: The updated at's $eq. + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * properties: {} + * test: + * type: object + * description: The $eq's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $eq's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $eq's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $eq's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $eq's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $eq's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * properties: {} + * test: + * type: object + * description: The $ne's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $ne's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $ne's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $ne's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $ne's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $ne's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $in's exec. + * properties: {} + * test: + * type: object + * description: The $in's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $in's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $in's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $in's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $in's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $in's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * properties: {} + * test: + * type: object + * description: The $nin's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $nin's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $nin's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $nin's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $nin's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $nin's @matchall@2360. + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The updated at's $not. + * - type: object + * description: The updated at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $not's exec. + * properties: {} + * test: + * type: object + * description: The $not's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $not's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $not's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $not's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $not's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $not's @matchall@2360. + * properties: {} + * - type: object + * description: The updated at's $not. + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * properties: {} + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * properties: {} + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $not's details. + * properties: {} + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The updated at's $not. + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $not's exec. + * properties: {} + * test: + * type: object + * description: The $not's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $not's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $not's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $not's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $not's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $not's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * properties: {} + * test: + * type: object + * description: The $gt's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $gt's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $gt's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $gt's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $gt's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $gt's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * properties: {} + * test: + * type: object + * description: The $gte's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $gte's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $gte's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $gte's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $gte's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $gte's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * properties: {} + * test: + * type: object + * description: The $lt's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $lt's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $lt's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $lt's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $lt's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $lt's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * properties: {} + * test: + * type: object + * description: The $lte's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $lte's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $lte's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $lte's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $lte's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $lte's @matchall@2360. + * properties: {} + * $like: + * type: string + * title: $like + * description: The updated at's $like. + * $re: + * type: string + * title: $re + * description: The updated at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The updated at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The updated at's $fulltext. + * $overlap: + * type: array + * description: The updated at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The updated at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The updated at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The updated at's $exists. + * deleted_at: + * type: object + * description: The product's deleted at. + * properties: + * $and: + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $and's exec. + * properties: {} + * test: + * type: object + * description: The $and's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $and's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $and's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $and's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $and's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $and's @matchall@2360. + * properties: {} + * - 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * properties: {} + * - 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 + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $and's $not. + * properties: {} + * - 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 + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $and's exec. + * properties: {} + * test: + * type: object + * description: The $and's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $and's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $and's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $and's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $and's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $and's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $or's exec. + * properties: {} + * test: + * type: object + * description: The $or's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $or's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $or's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $or's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $or's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $or's @matchall@2360. + * properties: {} + * - 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * properties: {} + * - 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 + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $or's $not. + * properties: {} + * - 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 + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $or's exec. + * properties: {} + * test: + * type: object + * description: The $or's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $or's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $or's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $or's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $or's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $or's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * properties: {} + * test: + * type: object + * description: The $eq's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $eq's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $eq's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $eq's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $eq's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $eq's @matchall@2360. + * properties: {} + * - type: array + * description: The deleted at's $eq. + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * properties: {} + * test: + * type: object + * description: The $eq's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $eq's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $eq's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $eq's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $eq's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $eq's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * properties: {} + * test: + * type: object + * description: The $ne's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $ne's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $ne's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $ne's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $ne's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $ne's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $in's exec. + * properties: {} + * test: + * type: object + * description: The $in's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $in's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $in's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $in's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $in's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $in's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * properties: {} + * test: + * type: object + * description: The $nin's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $nin's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $nin's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $nin's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $nin's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $nin's @matchall@2360. + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The deleted at's $not. + * - type: object + * description: The deleted at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $not's exec. + * properties: {} + * test: + * type: object + * description: The $not's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $not's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $not's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $not's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $not's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $not's @matchall@2360. + * properties: {} + * - type: object + * description: The deleted at's $not. + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * properties: {} + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * properties: {} + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The $not's details. + * properties: {} + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The deleted at's $not. + * 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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $not's exec. + * properties: {} + * test: + * type: object + * description: The $not's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $not's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $not's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $not's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $not's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $not's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * properties: {} + * test: + * type: object + * description: The $gt's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $gt's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $gt's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $gt's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $gt's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $gt's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * properties: {} + * test: + * type: object + * description: The $gte's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $gte's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $gte's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $gte's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $gte's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $gte's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * properties: {} + * test: + * type: object + * description: The $lt's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $lt's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $lt's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $lt's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $lt's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $lt's @matchall@2360. + * properties: {} + * $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@2351 + * - __@replace@2353 + * - __@search@2356 + * - __@matchAll@2360 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * properties: {} + * test: + * type: object + * description: The $lte's test. + * properties: {} + * 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. + * properties: {} + * 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@2351: + * type: object + * description: The $lte's @match@2351. + * properties: {} + * __@replace@2353: + * type: object + * description: The $lte's @replace@2353. + * properties: {} + * __@search@2356: + * type: object + * description: The $lte's @search@2356. + * properties: {} + * __@split@2358: + * type: object + * description: The $lte's @split@2358. + * properties: {} + * __@matchAll@2360: + * type: object + * description: The $lte's @matchall@2360. + * properties: {} + * $like: + * type: string + * title: $like + * description: The deleted at's $like. + * $re: + * type: string + * title: $re + * description: The deleted at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The deleted at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The deleted at's $fulltext. + * $overlap: + * type: array + * description: The deleted at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The deleted at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The deleted at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The deleted at's $exists. + * $and: + * type: array + * description: The product's $and. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $and's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * title: + * type: string + * title: title + * description: The $and's title. + * handle: + * type: string + * title: handle + * description: The $and's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * price_list_id: + * type: array + * description: The $and's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * sales_channel_id: + * type: array + * description: The $and's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * collection_id: + * type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $and's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $and's variants. + * properties: {} + * created_at: + * type: object + * description: The $and's created at. + * properties: + * $and: + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The created at's $eq. + * - type: object + * description: The created at's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The created at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The created at's $ne. + * - type: object + * description: The created at's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The created at's $not. + * - type: object + * description: The created at's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The created at's $not. + * properties: {} + * - type: array + * description: The created at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The created at's $gt. + * - type: object + * description: The created at's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The created at's $gte. + * - type: object + * description: The created at's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The created at's $lt. + * - type: object + * description: The created at's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The created at's $lte. + * - type: object + * description: The created at's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The created at's $like. + * $re: + * type: string + * title: $re + * description: The created at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The created at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The created at's $fulltext. + * $overlap: + * type: array + * description: The created at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The created at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The created at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The created at's $exists. + * updated_at: + * type: object + * description: The $and's updated at. + * properties: + * $and: + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The updated at's $eq. + * - type: object + * description: The updated at's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The updated at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The updated at's $ne. + * - type: object + * description: The updated at's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The updated at's $not. + * - type: object + * description: The updated at's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The updated at's $not. + * properties: {} + * - type: array + * description: The updated at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The updated at's $gt. + * - type: object + * description: The updated at's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The updated at's $gte. + * - type: object + * description: The updated at's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The updated at's $lt. + * - type: object + * description: The updated at's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The updated at's $lte. + * - type: object + * description: The updated at's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The updated at's $like. + * $re: + * type: string + * title: $re + * description: The updated at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The updated at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The updated at's $fulltext. + * $overlap: + * type: array + * description: The updated at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The updated at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The updated at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The updated at's $exists. + * deleted_at: + * type: object + * description: The $and's deleted at. + * properties: + * $and: + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The deleted at's $eq. + * - type: object + * description: The deleted at's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The deleted at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The deleted at's $ne. + * - type: object + * description: The deleted at's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The deleted at's $not. + * - type: object + * description: The deleted at's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The deleted at's $not. + * properties: {} + * - type: array + * description: The deleted at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The deleted at's $gt. + * - type: object + * description: The deleted at's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The deleted at's $gte. + * - type: object + * description: The deleted at's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The deleted at's $lt. + * - type: object + * description: The deleted at's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The deleted at's $lte. + * - type: object + * description: The deleted at's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The deleted at's $like. + * $re: + * type: string + * title: $re + * description: The deleted at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The deleted at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The deleted at's $fulltext. + * $overlap: + * type: array + * description: The deleted at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The deleted at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The deleted at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The deleted at's $exists. + * $and: + * type: array + * description: The $and's details. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $and's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * title: + * type: string + * title: title + * description: The $and's title. + * handle: + * type: string + * title: handle + * description: The $and's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * price_list_id: + * type: array + * description: The $and's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * sales_channel_id: + * type: array + * description: The $and's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * collection_id: + * type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $and's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $and's variants. + * properties: {} + * created_at: + * type: object + * description: The $and's created at. + * properties: {} + * updated_at: + * type: object + * description: The $and's updated at. + * properties: {} + * deleted_at: + * type: object + * description: The $and's deleted at. + * properties: {} + * $and: + * type: array + * description: The $and's details. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * $or: + * type: array + * description: The $and's $or. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * expand: + * type: string + * title: expand + * description: The $and's expand. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * order: + * type: string + * title: order + * description: The $and's order. + * $or: + * type: array + * description: The $and's $or. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $or's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * title: + * type: string + * title: title + * description: The $or's title. + * handle: + * type: string + * title: handle + * description: The $or's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * price_list_id: + * type: array + * description: The $or's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * sales_channel_id: + * type: array + * description: The $or's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * collection_id: + * type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $or's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $or's variants. + * properties: {} + * created_at: + * type: object + * description: The $or's created at. + * properties: {} + * updated_at: + * type: object + * description: The $or's updated at. + * properties: {} + * deleted_at: + * type: object + * description: The $or's deleted at. + * properties: {} + * $and: + * type: array + * description: The $or's $and. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * $or: + * type: array + * description: The $or's details. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * expand: + * type: string + * title: expand + * description: The $or's expand. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * order: + * type: string + * title: order + * description: The $or's order. + * expand: + * type: string + * title: expand + * description: The $and's expand. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * order: + * type: string + * title: order + * description: The $and's order. + * $or: + * type: array + * description: The product's $or. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $or's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * title: + * type: string + * title: title + * description: The $or's title. + * handle: + * type: string + * title: handle + * description: The $or's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * price_list_id: + * type: array + * description: The $or's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * sales_channel_id: + * type: array + * description: The $or's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * collection_id: + * type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $or's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $or's variants. + * properties: {} + * created_at: + * type: object + * description: The $or's created at. + * properties: + * $and: + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The created at's $eq. + * - type: object + * description: The created at's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The created at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The created at's $ne. + * - type: object + * description: The created at's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The created at's $not. + * - type: object + * description: The created at's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The created at's $not. + * properties: {} + * - type: array + * description: The created at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The created at's $gt. + * - type: object + * description: The created at's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The created at's $gte. + * - type: object + * description: The created at's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The created at's $lt. + * - type: object + * description: The created at's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The created at's $lte. + * - type: object + * description: The created at's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The created at's $like. + * $re: + * type: string + * title: $re + * description: The created at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The created at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The created at's $fulltext. + * $overlap: + * type: array + * description: The created at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The created at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The created at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The created at's $exists. + * updated_at: + * type: object + * description: The $or's updated at. + * properties: + * $and: + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The updated at's $eq. + * - type: object + * description: The updated at's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The updated at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The updated at's $ne. + * - type: object + * description: The updated at's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The updated at's $not. + * - type: object + * description: The updated at's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The updated at's $not. + * properties: {} + * - type: array + * description: The updated at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The updated at's $gt. + * - type: object + * description: The updated at's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The updated at's $gte. + * - type: object + * description: The updated at's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The updated at's $lt. + * - type: object + * description: The updated at's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The updated at's $lte. + * - type: object + * description: The updated at's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The updated at's $like. + * $re: + * type: string + * title: $re + * description: The updated at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The updated at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The updated at's $fulltext. + * $overlap: + * type: array + * description: The updated at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The updated at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The updated at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The updated at's $exists. + * deleted_at: + * type: object + * description: The $or's deleted at. + * properties: + * $and: + * 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 + * properties: {} + * - type: object + * description: The $and's details. + * properties: {} + * - 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 + * properties: {} + * $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 + * properties: {} + * - type: object + * description: The $or's details. + * properties: {} + * - 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 + * properties: {} + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The deleted at's $eq. + * - type: object + * description: The deleted at's $eq. + * x-schemaName: RegExp + * properties: {} + * - type: array + * description: The deleted at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * properties: {} + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The deleted at's $ne. + * - type: object + * description: The deleted at's $ne. + * x-schemaName: RegExp + * properties: {} + * $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 + * properties: {} + * $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 + * properties: {} + * $not: + * oneOf: + * - type: string + * title: $not + * description: The deleted at's $not. + * - type: object + * description: The deleted at's $not. + * x-schemaName: RegExp + * properties: {} + * - type: object + * description: The deleted at's $not. + * properties: {} + * - type: array + * description: The deleted at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * properties: {} + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The deleted at's $gt. + * - type: object + * description: The deleted at's $gt. + * x-schemaName: RegExp + * properties: {} + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The deleted at's $gte. + * - type: object + * description: The deleted at's $gte. + * x-schemaName: RegExp + * properties: {} + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The deleted at's $lt. + * - type: object + * description: The deleted at's $lt. + * x-schemaName: RegExp + * properties: {} + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The deleted at's $lte. + * - type: object + * description: The deleted at's $lte. + * x-schemaName: RegExp + * properties: {} + * $like: + * type: string + * title: $like + * description: The deleted at's $like. + * $re: + * type: string + * title: $re + * description: The deleted at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The deleted at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The deleted at's $fulltext. + * $overlap: + * type: array + * description: The deleted at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The deleted at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The deleted at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The deleted at's $exists. + * $and: + * type: array + * description: The $or's $and. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $and's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * title: + * type: string + * title: title + * description: The $and's title. + * handle: + * type: string + * title: handle + * description: The $and's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * price_list_id: + * type: array + * description: The $and's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * sales_channel_id: + * type: array + * description: The $and's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * collection_id: + * type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $and's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $and's variants. + * properties: {} + * created_at: + * type: object + * description: The $and's created at. + * properties: {} + * updated_at: + * type: object + * description: The $and's updated at. + * properties: {} + * deleted_at: + * type: object + * description: The $and's deleted at. + * properties: {} + * $and: + * type: array + * description: The $and's details. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * $or: + * type: array + * description: The $and's $or. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * expand: + * type: string + * title: expand + * description: The $and's expand. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * order: + * type: string + * title: order + * description: The $and's order. + * $or: + * type: array + * description: The $or's details. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * status: + * type: array + * description: The $or's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * title: + * type: string + * title: title + * description: The $or's title. + * handle: + * type: string + * title: handle + * description: The $or's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * price_list_id: + * type: array + * description: The $or's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * sales_channel_id: + * type: array + * description: The $or's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * collection_id: + * type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * tags: + * type: array + * description: The $or's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * type_id: + * type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * variants: + * type: object + * description: The $or's variants. + * properties: {} + * created_at: + * type: object + * description: The $or's created at. + * properties: {} + * updated_at: + * type: object + * description: The $or's updated at. + * properties: {} + * deleted_at: + * type: object + * description: The $or's deleted at. + * properties: {} + * $and: + * type: array + * description: The $or's $and. + * items: + * type: object + * description: The $and's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * $or: + * type: array + * description: The $or's details. + * items: + * type: object + * description: The $or's details. + * x-schemaName: AdminGetProductsParams + * properties: {} + * expand: + * type: string + * title: expand + * description: The $or's expand. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * order: + * type: string + * title: order + * description: The $or's order. + * expand: + * type: string + * title: expand + * description: The $or's expand. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * order: + * type: string + * title: order + * description: The $or's order. + * expand: + * type: string + * title: expand + * description: The product's expand. + * fields: + * type: string + * title: fields + * description: The product's fields. + * offset: + * type: number + * title: offset + * description: The product's offset. + * limit: + * type: number + * title: limit + * description: The product's limit. + * order: + * type: string + * title: order + * description: The product's order. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id].ts b/docs-util/oas-output/operations/admin/get_admin_products_[id].ts index fa92226f64..4eebc6e5ad 100644 --- a/docs-util/oas-output/operations/admin/get_admin_products_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts b/docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts index db8b4d2235..02367daf56 100644 --- a/docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts b/docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts index fcece8ac26..795b6c056f 100644 --- a/docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts b/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts index 31a11f19a6..feeead4d00 100644 --- a/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts b/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts index 698c1e8caa..2a337e20d2 100644 --- a/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_promotions.ts b/docs-util/oas-output/operations/admin/get_admin_promotions.ts index 93ae0864fc..f14334e401 100644 --- a/docs-util/oas-output/operations/admin/get_admin_promotions.ts +++ b/docs-util/oas-output/operations/admin/get_admin_promotions.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts b/docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts index adf58e8f01..217f8404c3 100644 --- a/docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -60,7 +20,15 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminGetPromotionsParams" + * type: object + * description: SUMMARY + * properties: + * fields: + * type: string + * title: fields + * description: The promotion's fields. + * required: + * - fields * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts b/docs-util/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts new file mode 100644 index 0000000000..9e60a4c09e --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts @@ -0,0 +1,50 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * - name: rule_type + * in: path + * description: The promotion's rule type. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/promotions/{id}/{rule_type}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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/docs-util/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts b/docs-util/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts new file mode 100644 index 0000000000..3e2290e5fa --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts @@ -0,0 +1,45 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: rule_type + * in: path + * description: The promotion's rule type. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/promotions/rule-attribute-options/{rule_type}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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/docs-util/oas-output/operations/admin/get_admin_promotions_rule-operator-options.ts b/docs-util/oas-output/operations/admin/get_admin_promotions_rule-operator-options.ts new file mode 100644 index 0000000000..43385d8767 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_promotions_rule-operator-options.ts @@ -0,0 +1,38 @@ +/** + * @oas [get] /admin/promotions/rule-operator-options + * operationId: GetPromotionsRuleOperatorOptions + * 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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/promotions/rule-operator-options' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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/docs-util/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts b/docs-util/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts new file mode 100644 index 0000000000..27c6a02830 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts @@ -0,0 +1,53 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: rule_type + * in: path + * description: The promotion's rule type. + * required: true + * schema: + * type: string + * - name: rule_attribute_id + * in: path + * description: The promotion's rule attribute id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl + * '{backend_url}/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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/docs-util/oas-output/operations/admin/get_admin_regions.ts b/docs-util/oas-output/operations/admin/get_admin_regions.ts index a9c4b9a52f..66473dbe7c 100644 --- a/docs-util/oas-output/operations/admin/get_admin_regions.ts +++ b/docs-util/oas-output/operations/admin/get_admin_regions.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_regions_[id].ts b/docs-util/oas-output/operations/admin/get_admin_regions_[id].ts index 1c9eb1cd75..8416b3679a 100644 --- a/docs-util/oas-output/operations/admin/get_admin_regions_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_regions_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -80,7 +40,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The region's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_reservations.ts b/docs-util/oas-output/operations/admin/get_admin_reservations.ts new file mode 100644 index 0000000000..42223c6f6b --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_reservations.ts @@ -0,0 +1,279 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - limit + * - fields + * - order + * - offset + * - location_id + * - inventory_item_id + * - line_item_id + * - created_by + * - description + * - quantity + * - created_at + * - updated_at + * - deleted_at + * properties: + * limit: + * type: number + * title: limit + * description: The reservation's limit. + * fields: + * type: string + * title: fields + * description: The reservation's fields. + * order: + * type: string + * title: order + * description: The reservation's order. + * offset: + * type: number + * title: offset + * description: The reservation's offset. + * location_id: + * oneOf: + * - type: string + * title: location_id + * description: The reservation's location id. + * - type: array + * description: The reservation's location id. + * items: + * type: string + * title: location_id + * description: The location id's details. + * inventory_item_id: + * oneOf: + * - type: string + * title: inventory_item_id + * description: The reservation's inventory item id. + * - type: array + * description: The reservation's inventory item id. + * items: + * type: string + * title: inventory_item_id + * description: The inventory item id's details. + * line_item_id: + * oneOf: + * - type: string + * title: line_item_id + * description: The reservation's line item id. + * - type: array + * description: The reservation's line item id. + * items: + * type: string + * title: line_item_id + * description: The line item id's details. + * created_by: + * oneOf: + * - type: string + * title: created_by + * description: The reservation's created by. + * - type: array + * description: The reservation's created by. + * items: + * type: string + * title: created_by + * description: The created by's details. + * description: + * oneOf: + * - type: string + * title: description + * description: The reservation's description. + * - type: object + * description: The reservation's description. + * 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: {} + * quantity: + * type: object + * description: The reservation's quantity. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * created_at: + * type: object + * 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: {} + * updated_at: + * type: object + * 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: {} + * deleted_at: + * type: object + * 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: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/reservations' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "limit": 7964169955442688, + * "fields": "{value}", + * "order": "{value}", + * "offset": 3052067430072320, + * "quantity": {}, + * "created_at": {}, + * "updated_at": {}, + * "deleted_at": {} + * }' + * tags: + * - Reservations + * 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/docs-util/oas-output/operations/admin/get_admin_reservations_[id].ts b/docs-util/oas-output/operations/admin/get_admin_reservations_[id].ts new file mode 100644 index 0000000000..dd9d96ec82 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_reservations_[id].ts @@ -0,0 +1,61 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The reservation's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The reservation's fields. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/reservations/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "fields": "{value}" + * }' + * tags: + * - Reservations + * 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/docs-util/oas-output/operations/admin/get_admin_sales-channels.ts b/docs-util/oas-output/operations/admin/get_admin_sales-channels.ts index 50afe5dcf9..4b3beeba8e 100644 --- a/docs-util/oas-output/operations/admin/get_admin_sales-channels.ts +++ b/docs-util/oas-output/operations/admin/get_admin_sales-channels.ts @@ -6,47 +6,7 @@ * filtered by fields such as `id`. The sales channels can also be sorted or * paginated. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts b/docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts index 6209d21c75..78bd9ed8c2 100644 --- a/docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -80,7 +40,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The sales channel's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_shipping-options.ts b/docs-util/oas-output/operations/admin/get_admin_shipping-options.ts new file mode 100644 index 0000000000..4ea93e3180 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_shipping-options.ts @@ -0,0 +1,74 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - fields + * - offset + * - limit + * - order + * properties: + * fields: + * type: string + * title: fields + * description: The shipping option's fields. + * offset: + * type: number + * title: offset + * description: The shipping option's offset. + * limit: + * type: number + * title: limit + * description: The shipping option's limit. + * order: + * type: string + * title: order + * description: The shipping option's order. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/shipping-options' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "fields": "{value}", + * "offset": 8788876090933248, + * "limit": 2996103177830400, + * "order": "{value}" + * }' + * tags: + * - Shipping Options + * 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/docs-util/oas-output/operations/admin/get_admin_shipping-profiles.ts b/docs-util/oas-output/operations/admin/get_admin_shipping-profiles.ts new file mode 100644 index 0000000000..b6c7122e0e --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_shipping-profiles.ts @@ -0,0 +1,39 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/shipping-profiles' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Shipping Profiles + * 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/docs-util/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts b/docs-util/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts new file mode 100644 index 0000000000..2bf1656d8c --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts @@ -0,0 +1,61 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The shipping profile's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The shipping profile's fields. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/shipping-profiles/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "fields": "{value}" + * }' + * tags: + * - Shipping Profiles + * 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/docs-util/oas-output/operations/admin/get_admin_stock-locations.ts b/docs-util/oas-output/operations/admin/get_admin_stock-locations.ts new file mode 100644 index 0000000000..af34be783e --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_stock-locations.ts @@ -0,0 +1,39 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/stock-locations' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Stock Locations + * 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/docs-util/oas-output/operations/admin/get_admin_stock-locations_[id].ts b/docs-util/oas-output/operations/admin/get_admin_stock-locations_[id].ts index ca7eff797c..3cdfeeb3ed 100644 --- a/docs-util/oas-output/operations/admin/get_admin_stock-locations_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_stock-locations_[id].ts @@ -25,8 +25,6 @@ * tags: * - Stock Locations * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -39,6 +37,19 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The stock location's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_stores.ts b/docs-util/oas-output/operations/admin/get_admin_stores.ts index 6d2def2e7f..a26fbbcd8d 100644 --- a/docs-util/oas-output/operations/admin/get_admin_stores.ts +++ b/docs-util/oas-output/operations/admin/get_admin_stores.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_stores_[id].ts b/docs-util/oas-output/operations/admin/get_admin_stores_[id].ts index e11d3289e9..c9d1f67878 100644 --- a/docs-util/oas-output/operations/admin/get_admin_stores_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_stores_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -80,7 +40,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The store's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_tax-rates.ts b/docs-util/oas-output/operations/admin/get_admin_tax-rates.ts index ca456fe187..49182831df 100644 --- a/docs-util/oas-output/operations/admin/get_admin_tax-rates.ts +++ b/docs-util/oas-output/operations/admin/get_admin_tax-rates.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts b/docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts index 8431003a0c..5354153e7a 100644 --- a/docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -80,7 +40,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The tax rate's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_tax-regions.ts b/docs-util/oas-output/operations/admin/get_admin_tax-regions.ts new file mode 100644 index 0000000000..7856a6a9d8 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_tax-regions.ts @@ -0,0 +1,38 @@ +/** + * @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. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/tax-regions' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Tax Regions + * 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/docs-util/oas-output/operations/admin/get_admin_tax-regions_[id].ts b/docs-util/oas-output/operations/admin/get_admin_tax-regions_[id].ts new file mode 100644 index 0000000000..41acff29bb --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_tax-regions_[id].ts @@ -0,0 +1,44 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The tax region's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/tax-regions/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Tax Regions + * 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/docs-util/oas-output/operations/admin/get_admin_uploads_[id].ts b/docs-util/oas-output/operations/admin/get_admin_uploads_[id].ts new file mode 100644 index 0000000000..4c0a0ebb30 --- /dev/null +++ b/docs-util/oas-output/operations/admin/get_admin_uploads_[id].ts @@ -0,0 +1,44 @@ +/** + * @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. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The upload's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/uploads/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Uploads + * 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/docs-util/oas-output/operations/admin/get_admin_users.ts b/docs-util/oas-output/operations/admin/get_admin_users.ts index f2a05a06aa..eb7aa89beb 100644 --- a/docs-util/oas-output/operations/admin/get_admin_users.ts +++ b/docs-util/oas-output/operations/admin/get_admin_users.ts @@ -5,47 +5,7 @@ * 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: 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_users_[id].ts b/docs-util/oas-output/operations/admin/get_admin_users_[id].ts index 626c298cb0..6d66c57375 100644 --- a/docs-util/oas-output/operations/admin/get_admin_users_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_users_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_users_me.ts b/docs-util/oas-output/operations/admin/get_admin_users_me.ts index 6b034a9c89..f909459d16 100644 --- a/docs-util/oas-output/operations/admin/get_admin_users_me.ts +++ b/docs-util/oas-output/operations/admin/get_admin_users_me.ts @@ -5,47 +5,7 @@ * 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: 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts index f6956cbb74..ae77c1313a 100644 --- a/docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts @@ -6,47 +6,7 @@ * can be filtered by fields such as `id`. The workflows executions can also be * sorted or paginated. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -75,7 +35,54 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - limit + * - fields + * - order + * - offset + * - transaction_id + * - workflow_id + * properties: + * limit: + * type: number + * title: limit + * description: The workflows execution's limit. + * fields: + * type: string + * title: fields + * description: The workflows execution's fields. + * order: + * type: string + * title: order + * description: The workflows execution's order. + * offset: + * type: number + * title: offset + * description: The workflows execution's offset. + * transaction_id: + * oneOf: + * - type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * - type: array + * description: The workflows execution's transaction id. + * items: + * type: string + * title: transaction_id + * description: The transaction id's details. + * workflow_id: + * oneOf: + * - type: string + * title: workflow_id + * description: The workflows execution's workflow id. + * - type: array + * description: The workflows execution's workflow id. + * items: + * type: string + * title: workflow_id + * description: The workflow id's details. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts index e74fdba6df..e8501e4169 100644 --- a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -80,7 +40,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The workflows execution's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts index b5a51d26cd..1430bc2d12 100644 --- a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -89,7 +49,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The workflows execution's fields. * */ diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts index 76046d82a6..c5920cfd10 100644 --- a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts @@ -25,46 +25,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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts index 4b066d045e..505a583fec 100644 --- a/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts +++ b/docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts @@ -13,46 +13,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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/post_admin_api-keys.ts b/docs-util/oas-output/operations/admin/post_admin_api-keys.ts index d4f922c930..2a64f5db8a 100644 --- a/docs-util/oas-output/operations/admin/post_admin_api-keys.ts +++ b/docs-util/oas-output/operations/admin/post_admin_api-keys.ts @@ -4,47 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,17 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - title + * - type + * properties: + * title: + * type: string + * title: title + * description: The api key's title. + * type: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts index e4267e85b8..21c7b31bb2 100644 --- a/docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - title + * properties: + * title: + * type: string + * title: title + * description: The api key's title. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts index ab08d6889e..4654432a33 100644 --- a/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts +++ b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - revoke_in + * properties: + * revoke_in: + * type: number + * title: revoke_in + * description: The api key's revoke in. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts new file mode 100644 index 0000000000..6f742690dc --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts @@ -0,0 +1,64 @@ +/** + * @oas [post] /admin/api-keys/{id}/sales-channels + * operationId: PostApiKeysIdSalesChannels + * summary: Add Sales Channels to Api Key + * description: Add a list of sales channels to a api key. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The api key's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The api key's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The api key's remove. + * items: + * type: string + * title: remove + * description: The remove's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/api-keys/{id}/sales-channels' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Api Keys + * 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/docs-util/oas-output/operations/admin/post_admin_campaigns.ts b/docs-util/oas-output/operations/admin/post_admin_campaigns.ts index 9a8f512325..2aaae33f29 100644 --- a/docs-util/oas-output/operations/admin/post_admin_campaigns.ts +++ b/docs-util/oas-output/operations/admin/post_admin_campaigns.ts @@ -4,47 +4,7 @@ * summary: Create Campaign * description: Create a campaign. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,69 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - name + * - campaign_identifier + * - description + * - currency + * - budget + * - starts_at + * - ends_at + * - promotions + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * currency: + * type: string + * title: currency + * description: The campaign's currency. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - type + * - limit + * properties: + * type: {} + * limit: + * type: number + * title: limit + * description: The budget's limit. + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * format: date-time + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * format: date-time + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts b/docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts index 5c961d05f7..e9f08422f8 100644 --- a/docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,70 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostCampaignsReq" + * type: object + * description: The promotion's campaign. + * required: + * - name + * - campaign_identifier + * - description + * - currency + * - budget + * - starts_at + * - ends_at + * - promotions + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * currency: + * type: string + * title: currency + * description: The campaign's currency. + * budget: + * type: object + * description: The campaign's budget. + * properties: + * type: + * enum: + * - spend + * - usage + * limit: + * type: number + * title: limit + * description: The budget's limit. + * required: + * - type + * - limit + * 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. + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_collections.ts b/docs-util/oas-output/operations/admin/post_admin_collections.ts index 77e18ae18d..4aadae6faa 100644 --- a/docs-util/oas-output/operations/admin/post_admin_collections.ts +++ b/docs-util/oas-output/operations/admin/post_admin_collections.ts @@ -4,47 +4,7 @@ * summary: Create Collection * description: Create a collection. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,25 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - title + * - handle + * - metadata + * properties: + * title: + * type: string + * title: title + * description: The collection's title. + * handle: + * type: string + * title: handle + * description: The collection's handle. + * metadata: + * type: object + * description: The collection's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_collections_[id].ts b/docs-util/oas-output/operations/admin/post_admin_collections_[id].ts index 6c94530ad9..8b16c65d30 100644 --- a/docs-util/oas-output/operations/admin/post_admin_collections_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_collections_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,25 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - title + * - handle + * - metadata + * properties: + * title: + * type: string + * title: title + * description: The collection's title. + * handle: + * type: string + * title: handle + * description: The collection's handle. + * metadata: + * type: object + * description: The collection's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_collections_[id]_products.ts b/docs-util/oas-output/operations/admin/post_admin_collections_[id]_products.ts new file mode 100644 index 0000000000..c1e09968df --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_collections_[id]_products.ts @@ -0,0 +1,64 @@ +/** + * @oas [post] /admin/collections/{id}/products + * operationId: PostCollectionsIdProducts + * summary: Add Products to Collection + * description: Add a list of products to a collection. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The collection's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The collection's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The collection's remove. + * items: + * type: string + * title: remove + * description: The remove's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/collections/{id}/products' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Collections + * 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/docs-util/oas-output/operations/admin/post_admin_customer-groups.ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups.ts index fab715d7d2..cb38916fe6 100644 --- a/docs-util/oas-output/operations/admin/post_admin_customer-groups.ts +++ b/docs-util/oas-output/operations/admin/post_admin_customer-groups.ts @@ -4,47 +4,7 @@ * summary: Create Customer Group * description: Create a customer group. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - name + * properties: + * name: + * type: string + * title: name + * description: The customer group's name. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts index e75bdbf4c5..6cc7235f4d 100644 --- a/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - name + * properties: + * name: + * type: string + * title: name + * description: The customer group's name. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts new file mode 100644 index 0000000000..769ad9d9e9 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts @@ -0,0 +1,64 @@ +/** + * @oas [post] /admin/customer-groups/{id}/customers + * operationId: PostCustomerGroupsIdCustomers + * summary: Add Customers to Customer Group + * description: Add a list of customers to a customer group. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The customer group's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The customer group's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The customer group's remove. + * items: + * type: string + * title: remove + * description: The remove's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/customer-groups/{id}/customers' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Customer Groups + * 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/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_batch.ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_batch.ts deleted file mode 100644 index 9b9dfd9512..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_batch.ts +++ /dev/null @@ -1,94 +0,0 @@ -/** - * @oas [post] /admin/customer-groups/{id}/customers/batch - * operationId: PostCustomerGroupsIdCustomersBatch - * summary: Add Customers to Customer Group - * description: Add a list of customers to a customer group. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The customer group'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/batch' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "customer_ids": [ - * { - * "id": "id_dx2Wieq4uGG" - * } - * ] - * }' - * tags: - * - Customer Groups - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_remove.ts b/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_remove.ts deleted file mode 100644 index f70771ebe5..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers_remove.ts +++ /dev/null @@ -1,94 +0,0 @@ -/** - * @oas [post] /admin/customer-groups/{id}/customers/remove - * operationId: PostCustomerGroupsIdCustomersRemove - * summary: Add Removes to Customer Group - * description: Add a list of removes to a customer group. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The customer group'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/remove' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "customer_ids": [ - * { - * "id": "id_oAhMZi39hsjIOqPA6" - * } - * ] - * }' - * tags: - * - Customer Groups - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_customers.ts b/docs-util/oas-output/operations/admin/post_admin_customers.ts index 016711fa64..55f06ae410 100644 --- a/docs-util/oas-output/operations/admin/post_admin_customers.ts +++ b/docs-util/oas-output/operations/admin/post_admin_customers.ts @@ -4,47 +4,7 @@ * summary: Create Customer * description: Create a customer. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -58,6 +18,11 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: {} * "400": * $ref: "#/components/responses/400_error" * "401": @@ -73,7 +38,36 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - email + * - company_name + * - first_name + * - last_name + * - phone + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_customers_[id].ts b/docs-util/oas-output/operations/admin/post_admin_customers_[id].ts index d070372b90..f1e865ce0a 100644 --- a/docs-util/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_customers_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +24,11 @@ * tags: * - Customers * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: {} * "400": * $ref: "#/components/responses/400_error" * "401": @@ -79,7 +44,36 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - email + * - company_name + * - first_name + * - last_name + * - phone + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index 74165107df..68689bb87e 100644 --- a/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,80 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - address_name + * - is_default_shipping + * - is_default_billing + * - company + * - first_name + * - last_name + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - phone + * - metadata + * properties: + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. + * company: + * type: string + * title: company + * description: The customer's company. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index 2eec3b19d2..11e20f55b7 100644 --- a/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -17,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -85,7 +45,80 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - address_name + * - is_default_shipping + * - is_default_billing + * - company + * - first_name + * - last_name + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - phone + * - metadata + * properties: + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. + * company: + * type: string + * title: company + * description: The customer's company. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_draft-orders.ts b/docs-util/oas-output/operations/admin/post_admin_draft-orders.ts new file mode 100644 index 0000000000..80947267cb --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_draft-orders.ts @@ -0,0 +1,394 @@ +/** + * @oas [post] /admin/draft-orders + * operationId: PostDraftOrders + * summary: Create Draft Order + * description: Create a draft order. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - status + * - sales_channel_id + * - email + * - customer_id + * - billing_address + * - shipping_address + * - items + * - region_id + * - promo_codes + * - currency_code + * - no_notification_order + * - shipping_methods + * - metadata + * properties: + * status: + * type: boolean + * title: status + * description: The draft order's status. + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The draft order's sales channel id. + * email: + * type: string + * title: email + * description: The draft order's email. + * format: email + * customer_id: + * type: string + * title: customer_id + * description: The draft order's customer id. + * billing_address: + * type: object + * description: The draft order's billing address. + * required: + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - metadata + * properties: + * 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. + * properties: {} + * shipping_address: + * type: object + * description: The draft order's shipping address. + * required: + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - metadata + * properties: + * first_name: + * type: string + * title: first_name + * description: The shipping address's first name. + * last_name: + * type: string + * title: last_name + * description: The shipping address's last name. + * phone: + * type: string + * title: phone + * description: The shipping address's phone. + * company: + * type: string + * title: company + * description: The shipping address's company. + * address_1: + * type: string + * title: address_1 + * description: The shipping address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The shipping address's address 2. + * city: + * type: string + * title: city + * description: The shipping address's city. + * country_code: + * type: string + * title: country_code + * description: The shipping address's country code. + * province: + * type: string + * title: province + * description: The shipping address's province. + * postal_code: + * type: string + * title: postal_code + * description: The shipping address's postal code. + * metadata: + * type: object + * description: The shipping address's metadata. + * properties: {} + * items: + * type: array + * description: The draft order's items. + * items: + * type: object + * description: The item's items. + * required: + * - title + * - sku + * - barcode + * - variant_id + * - unit_price + * - quantity + * - metadata + * properties: + * title: + * type: string + * title: title + * description: The item's title. + * sku: + * type: string + * title: sku + * description: The item's sku. + * barcode: + * type: string + * title: barcode + * description: The item's barcode. + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * 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: object + * description: The item's unit price. + * required: + * - value + * - precision + * properties: + * value: + * type: string + * title: value + * description: The unit price's value. + * precision: + * type: number + * title: precision + * description: The unit price's precision. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * metadata: + * type: object + * description: The item's metadata. + * properties: {} + * region_id: + * type: string + * title: region_id + * description: The draft order's region id. + * promo_codes: + * type: array + * description: The draft order's promo codes. + * items: + * type: string + * title: promo_codes + * description: The promo code's promo codes. + * currency_code: + * type: string + * title: currency_code + * description: The draft order's currency code. + * no_notification_order: + * type: boolean + * title: no_notification_order + * description: The draft order's no notification order. + * shipping_methods: + * type: array + * description: The draft order's shipping methods. + * items: + * type: object + * description: The shipping method's shipping methods. + * required: + * - shipping_method_id + * - order_id + * - name + * - option_id + * - data + * - amount + * properties: + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The shipping method's shipping method id. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * option_id: + * type: string + * title: option_id + * description: The shipping method's option id. + * data: + * type: object + * description: The shipping method's data. + * properties: {} + * amount: + * oneOf: + * - type: string + * title: amount + * description: The shipping method's amount. + * - type: number + * title: amount + * description: The shipping method's amount. + * - type: object + * description: The shipping method's amount. + * required: + * - value + * - precision + * properties: + * value: + * type: string + * title: value + * description: The amount's value. + * precision: + * type: number + * title: precision + * description: The amount's precision. + * metadata: + * type: object + * description: The draft order's metadata. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/draft-orders' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "status": false, + * "sales_channel_id": "{value}", + * "email": "Trent_Reilly67@gmail.com", + * "customer_id": "{value}", + * "billing_address": { + * "first_name": "{value}", + * "last_name": "{value}", + * "phone": "{value}", + * "company": "{value}", + * "address_1": "{value}", + * "address_2": "{value}", + * "city": "{value}", + * "country_code": "{value}", + * "province": "{value}", + * "postal_code": "{value}", + * "metadata": {} + * }, + * "shipping_address": { + * "first_name": "{value}", + * "last_name": "{value}", + * "phone": "{value}", + * "company": "{value}", + * "address_1": "{value}", + * "address_2": "{value}", + * "city": "{value}", + * "country_code": "{value}", + * "province": "{value}", + * "postal_code": "{value}", + * "metadata": {} + * }, + * "items": [ + * { + * "title": "{value}", + * "sku": "{value}", + * "barcode": "{value}", + * "variant_id": "{value}", + * "quantity": 4713312751190016, + * "metadata": {} + * } + * ], + * "region_id": "{value}", + * "promo_codes": [ + * "{value}" + * ], + * "currency_code": "{value}", + * "no_notification_order": false, + * "shipping_methods": [ + * { + * "shipping_method_id": "{value}", + * "order_id": "{value}", + * "name": "Golden", + * "option_id": "{value}", + * "data": {} + * } + * ], + * "metadata": {} + * }' + * tags: + * - Draft Orders + * 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/docs-util/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts b/docs-util/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts new file mode 100644 index 0000000000..823e4f8298 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts @@ -0,0 +1,173 @@ +/** + * @oas [post] /admin/fulfillment-sets/{id}/service-zones + * operationId: PostFulfillmentSetsIdServiceZones + * summary: Add Service Zones to Fulfillment Set + * description: Add a list of service zones to a fulfillment set. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment set's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - geo_zones + * properties: + * name: + * type: string + * title: name + * description: The fulfillment set's name. + * geo_zones: + * type: array + * description: The fulfillment set's geo zones. + * items: + * oneOf: + * - type: object + * description: The geo zone's geo zones. + * required: + * - metadata + * - country_code + * - type + * properties: + * metadata: + * type: object + * description: The geo zone's metadata. + * properties: {} + * country_code: + * type: string + * title: country_code + * description: The geo zone's country code. + * type: + * type: string + * title: type + * description: The geo zone's type. + * - type: object + * description: The geo zone's geo zones. + * required: + * - metadata + * - country_code + * - type + * - province_code + * properties: + * metadata: + * type: object + * description: The geo zone's metadata. + * properties: {} + * country_code: + * type: string + * title: country_code + * description: The geo zone's country code. + * type: + * type: string + * title: type + * description: The geo zone's type. + * province_code: + * type: string + * title: province_code + * description: The geo zone's province code. + * - type: object + * description: The geo zone's geo zones. + * required: + * - metadata + * - country_code + * - type + * - province_code + * - city + * properties: + * metadata: + * type: object + * description: The geo zone's metadata. + * properties: {} + * country_code: + * type: string + * title: country_code + * description: The geo zone's country code. + * type: + * type: string + * title: type + * description: The geo zone's type. + * province_code: + * type: string + * title: province_code + * description: The geo zone's province code. + * city: + * type: string + * title: city + * description: The geo zone's city. + * - type: object + * description: The geo zone's geo zones. + * required: + * - metadata + * - country_code + * - type + * - province_code + * - city + * - postal_expression + * properties: + * metadata: + * type: object + * description: The geo zone's metadata. + * properties: {} + * country_code: + * type: string + * title: country_code + * description: The geo zone's country code. + * type: + * type: string + * title: type + * description: The geo zone's type. + * province_code: + * type: string + * title: province_code + * description: The geo zone's province code. + * city: + * type: string + * title: city + * description: The geo zone's city. + * postal_expression: + * type: object + * description: The geo zone's postal expression. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Milan", + * "geo_zones": [] + * }' + * tags: + * - Fulfillment Sets + * 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/docs-util/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/docs-util/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts new file mode 100644 index 0000000000..0be5a45bfe --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -0,0 +1,203 @@ +/** + * @oas [post] /admin/fulfillment-sets/{id}/service-zones/{zone_id} + * operationId: PostFulfillmentSetsIdServiceZonesZone_id + * summary: Add Service Zones to Fulfillment Set + * description: Add a list of service zones to a fulfillment set. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment set's ID. + * required: true + * schema: + * type: string + * - name: zone_id + * in: path + * description: The fulfillment set's zone id. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - geo_zones + * properties: + * name: + * type: string + * title: name + * description: The fulfillment set's name. + * geo_zones: + * type: array + * description: The fulfillment set's geo zones. + * items: + * oneOf: + * - type: object + * description: The geo zone's geo zones. + * required: + * - type + * - metadata + * - country_code + * - id + * properties: + * type: + * type: string + * title: type + * description: The geo zone's type. + * metadata: + * type: object + * description: The geo zone's metadata. + * properties: {} + * country_code: + * type: string + * title: country_code + * description: The geo zone's country code. + * id: + * type: string + * title: id + * description: The geo zone's ID. + * - type: object + * description: The geo zone's geo zones. + * required: + * - type + * - metadata + * - country_code + * - province_code + * - id + * properties: + * type: + * type: string + * title: type + * description: The geo zone's type. + * metadata: + * type: object + * description: The geo zone's metadata. + * properties: {} + * country_code: + * type: string + * title: country_code + * description: The geo zone's country code. + * province_code: + * type: string + * title: province_code + * description: The geo zone's province code. + * id: + * type: string + * title: id + * description: The geo zone's ID. + * - type: object + * description: The geo zone's geo zones. + * required: + * - type + * - metadata + * - city + * - country_code + * - province_code + * - id + * properties: + * type: + * type: string + * title: type + * description: The geo zone's type. + * metadata: + * type: object + * description: The geo zone's metadata. + * properties: {} + * city: + * type: string + * title: city + * description: The geo zone's city. + * country_code: + * type: string + * title: country_code + * description: The geo zone's country code. + * province_code: + * type: string + * title: province_code + * description: The geo zone's province code. + * id: + * type: string + * title: id + * description: The geo zone's ID. + * - type: object + * description: The geo zone's geo zones. + * required: + * - type + * - metadata + * - city + * - country_code + * - province_code + * - postal_expression + * - id + * properties: + * type: + * type: string + * title: type + * description: The geo zone's type. + * metadata: + * type: object + * description: The geo zone's metadata. + * properties: {} + * city: + * type: string + * title: city + * description: The geo zone's city. + * country_code: + * type: string + * title: country_code + * description: The geo zone's country code. + * province_code: + * type: string + * title: province_code + * description: The geo zone's province code. + * postal_expression: + * type: object + * description: The geo zone's postal expression. + * properties: {} + * id: + * type: string + * title: id + * description: The geo zone's ID. + * x-codeSamples: + * - lang: Shell + * label: cURL + * 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": "Walker", + * "geo_zones": [] + * }' + * tags: + * - Fulfillment Sets + * 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/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_add.ts deleted file mode 100644 index 7071d14c80..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_add.ts +++ /dev/null @@ -1,98 +0,0 @@ -/** - * @oas [post] /admin/fulfillment/shipping-options/{id}/rules/batch/add - * operationId: PostFulfillmentShippingOptionsIdRulesBatchAdd - * summary: Add Adds to Fulfillment - * description: Add a list of adds to a fulfillment. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The fulfillment'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/add' \ - * - * -H 'x-medusa-access-token: {api_token}' \ - * - * -H 'Content-Type: application/json' \ - * - * --data-raw '{ - * "rules": [ - * { - * "attribute": "{value}" - * } - * ] - * }' - * tags: - * - Fulfillment - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_remove.ts deleted file mode 100644 index 00eff81413..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_fulfillment_shipping-options_[id]_rules_batch_remove.ts +++ /dev/null @@ -1,98 +0,0 @@ -/** - * @oas [post] /admin/fulfillment/shipping-options/{id}/rules/batch/remove - * operationId: PostFulfillmentShippingOptionsIdRulesBatchRemove - * summary: Add Removes to Fulfillment - * description: Add a list of removes to a fulfillment. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The fulfillment'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemove\ - * Req" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/remove' - * \ - * - * -H 'x-medusa-access-token: {api_token}' \ - * - * -H 'Content-Type: application/json' \ - * - * --data-raw '{ - * "rule_ids": [ - * "{value}" - * ] - * }' - * tags: - * - Fulfillment - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_fulfillments.ts b/docs-util/oas-output/operations/admin/post_admin_fulfillments.ts new file mode 100644 index 0000000000..b8d07b7890 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_fulfillments.ts @@ -0,0 +1,226 @@ +/** + * @oas [post] /admin/fulfillments + * operationId: PostFulfillments + * summary: Create Fulfillment + * description: Create a fulfillment. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - location_id + * - provider_id + * - delivery_address + * - items + * - labels + * - order + * - metadata + * properties: + * location_id: + * type: string + * title: location_id + * description: The fulfillment's location id. + * provider_id: + * type: string + * title: provider_id + * description: The fulfillment's provider id. + * delivery_address: + * type: object + * description: The fulfillment's delivery address. + * required: + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - metadata + * properties: + * first_name: + * type: string + * title: first_name + * description: The delivery address's first name. + * last_name: + * type: string + * title: last_name + * description: The delivery address's last name. + * phone: + * type: string + * title: phone + * description: The delivery address's phone. + * company: + * type: string + * title: company + * description: The delivery address's company. + * address_1: + * type: string + * title: address_1 + * description: The delivery address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The delivery address's address 2. + * city: + * type: string + * title: city + * description: The delivery address's city. + * country_code: + * type: string + * title: country_code + * description: The delivery address's country code. + * province: + * type: string + * title: province + * description: The delivery address's province. + * postal_code: + * type: string + * title: postal_code + * description: The delivery address's postal code. + * metadata: + * type: object + * description: The delivery address's metadata. + * properties: {} + * items: + * type: array + * description: The fulfillment's items. + * items: + * type: object + * description: The item's items. + * required: + * - title + * - sku + * - quantity + * - barcode + * - line_item_id + * - inventory_item_id + * properties: + * title: + * type: string + * title: title + * description: The item's title. + * sku: + * type: string + * title: sku + * description: The item's sku. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * barcode: + * type: string + * title: barcode + * description: The item's barcode. + * line_item_id: + * type: string + * title: line_item_id + * description: The item's line item id. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The item's inventory item id. + * labels: + * type: array + * description: The fulfillment's labels. + * items: + * type: object + * description: The label's labels. + * required: + * - tracking_number + * - tracking_url + * - label_url + * properties: + * tracking_number: + * type: string + * title: tracking_number + * description: The label's tracking number. + * tracking_url: + * type: string + * title: tracking_url + * description: The label's tracking url. + * label_url: + * type: string + * title: label_url + * description: The label's label url. + * order: + * type: object + * description: The fulfillment's order. + * properties: {} + * metadata: + * type: object + * description: The fulfillment's metadata. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/fulfillments' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "location_id": "{value}", + * "provider_id": "{value}", + * "delivery_address": { + * "first_name": "{value}", + * "last_name": "{value}", + * "phone": "{value}", + * "company": "{value}", + * "address_1": "{value}", + * "address_2": "{value}", + * "city": "{value}", + * "country_code": "{value}", + * "province": "{value}", + * "postal_code": "{value}", + * "metadata": {} + * }, + * "items": [ + * { + * "title": "{value}", + * "sku": "{value}", + * "quantity": 6350536800468992, + * "barcode": "{value}", + * "line_item_id": "{value}", + * "inventory_item_id": "{value}" + * } + * ], + * "labels": [ + * { + * "tracking_number": "{value}", + * "tracking_url": "{value}", + * "label_url": "{value}" + * } + * ], + * "order": {}, + * "metadata": {} + * }' + * tags: + * - Fulfillments + * 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/docs-util/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts b/docs-util/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts new file mode 100644 index 0000000000..9a566952ba --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts @@ -0,0 +1,50 @@ +/** + * @oas [post] /admin/fulfillments/{id}/cancel + * operationId: PostFulfillmentsIdCancel + * summary: Add Cancels to Fulfillment + * description: Add a list of cancels to a fulfillment. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/fulfillments/{id}/cancel' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Fulfillments + * 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/docs-util/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts b/docs-util/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts new file mode 100644 index 0000000000..555ee89b4d --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts @@ -0,0 +1,85 @@ +/** + * @oas [post] /admin/fulfillments/{id}/shipment + * operationId: PostFulfillmentsIdShipment + * summary: Add Shipments to Fulfillment + * description: Add a list of shipments to a fulfillment. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - labels + * properties: + * labels: + * type: array + * description: The fulfillment's labels. + * items: + * type: object + * description: The label's labels. + * required: + * - tracking_number + * - tracking_url + * - label_url + * properties: + * tracking_number: + * type: string + * title: tracking_number + * description: The label's tracking number. + * tracking_url: + * type: string + * title: tracking_url + * description: The label's tracking url. + * label_url: + * type: string + * title: label_url + * description: The label's label url. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/fulfillments/{id}/shipment' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "labels": [ + * { + * "tracking_number": "{value}", + * "tracking_url": "{value}", + * "label_url": "{value}" + * } + * ] + * }' + * tags: + * - Fulfillments + * 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/docs-util/oas-output/operations/admin/post_admin_inventory-items.ts b/docs-util/oas-output/operations/admin/post_admin_inventory-items.ts index b18bae9b09..9c629aef98 100644 --- a/docs-util/oas-output/operations/admin/post_admin_inventory-items.ts +++ b/docs-util/oas-output/operations/admin/post_admin_inventory-items.ts @@ -4,47 +4,7 @@ * summary: Create Inventory Item * description: Create a inventory item. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -53,7 +13,80 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostInventoryItemsReq" + * type: object + * description: SUMMARY + * properties: + * sku: + * type: string + * title: sku + * description: The inventory item's sku. + * hs_code: + * type: string + * title: hs_code + * description: The inventory item's hs code. + * weight: + * type: number + * title: weight + * description: The inventory item's weight. + * length: + * type: number + * title: length + * description: The inventory item's length. + * height: + * type: number + * title: height + * description: The inventory item's height. + * width: + * type: number + * title: width + * description: The inventory item's width. + * origin_country: + * type: string + * title: origin_country + * description: The inventory item's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The inventory item's mid code. + * material: + * type: string + * title: material + * description: The inventory item's material. + * title: + * type: string + * title: title + * description: The inventory item's title. + * description: + * type: string + * title: description + * description: The inventory item's description. + * thumbnail: + * type: string + * title: thumbnail + * description: The inventory item's thumbnail. + * metadata: + * type: object + * description: The inventory item's metadata. + * properties: {} + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The inventory item's requires shipping. + * required: + * - sku + * - hs_code + * - weight + * - length + * - height + * - width + * - origin_country + * - mid_code + * - material + * - title + * - description + * - requires_shipping + * - thumbnail + * - metadata * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id].ts b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id].ts index ab90502372..6439dfbb60 100644 --- a/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id].ts @@ -19,7 +19,80 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostInventoryItemsInventoryItemReq" + * type: object + * description: SUMMARY + * properties: + * sku: + * type: string + * title: sku + * description: The inventory item's sku. + * origin_country: + * type: string + * title: origin_country + * description: The inventory item's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The inventory item's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The inventory item's mid code. + * material: + * type: string + * title: material + * description: The inventory item's material. + * weight: + * type: number + * title: weight + * description: The inventory item's weight. + * height: + * type: number + * title: height + * description: The inventory item's height. + * length: + * type: number + * title: length + * description: The inventory item's length. + * width: + * type: number + * title: width + * description: The inventory item's width. + * title: + * type: string + * title: title + * description: The inventory item's title. + * description: + * type: string + * title: description + * description: The inventory item's description. + * thumbnail: + * type: string + * title: thumbnail + * description: The inventory item's thumbnail. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The inventory item's requires shipping. + * metadata: + * type: object + * description: The inventory item's metadata. + * properties: {} + * required: + * - sku + * - hs_code + * - weight + * - length + * - height + * - width + * - origin_country + * - mid_code + * - material + * - title + * - description + * - requires_shipping + * - thumbnail + * - metadata * x-codeSamples: * - lang: Shell * label: cURL @@ -29,8 +102,6 @@ * tags: * - Inventory Items * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts index 29556efb66..737657202a 100644 --- a/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts +++ b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,25 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq" + * type: object + * description: SUMMARY + * required: + * - location_id + * - stocked_quantity + * - incoming_quantity + * properties: + * location_id: + * type: string + * title: location_id + * description: The inventory item's location id. + * stocked_quantity: + * type: number + * title: stocked_quantity + * description: The inventory item's stocked quantity. + * incoming_quantity: + * type: number + * title: incoming_quantity + * description: The inventory item's incoming quantity. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts index d59f05de5f..40828973d2 100644 --- a/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -25,7 +25,20 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq" + * type: object + * description: SUMMARY + * properties: + * incoming_quantity: + * type: number + * title: incoming_quantity + * description: The inventory item's incoming quantity. + * stocked_quantity: + * type: number + * title: stocked_quantity + * description: The inventory item's stocked quantity. + * required: + * - stocked_quantity + * - incoming_quantity * x-codeSamples: * - lang: Shell * label: cURL @@ -37,8 +50,6 @@ * tags: * - Inventory Items * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts new file mode 100644 index 0000000000..94bf04b394 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts @@ -0,0 +1,45 @@ +/** + * @oas [post] /admin/inventory-items/{id}/location-levels/batch + * operationId: PostInventoryItemsIdLocationLevelsBatch + * summary: Add Location Levels to Inventory Item + * description: Add a list of location levels to a inventory item. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The inventory item's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Inventory Items + * 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/docs-util/oas-output/operations/admin/post_admin_invites.ts b/docs-util/oas-output/operations/admin/post_admin_invites.ts index 29e6c2f380..953f8a69e7 100644 --- a/docs-util/oas-output/operations/admin/post_admin_invites.ts +++ b/docs-util/oas-output/operations/admin/post_admin_invites.ts @@ -4,47 +4,7 @@ * summary: Create Invite * description: Create a invite. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,16 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - email + * properties: + * email: + * type: string + * title: email + * description: The invite's email. + * format: email * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts b/docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts index 6219f43bc7..b7c4a23b9e 100644 --- a/docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts +++ b/docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/post_admin_invites_accept.ts b/docs-util/oas-output/operations/admin/post_admin_invites_accept.ts index da616480e6..5a6b4fef4f 100644 --- a/docs-util/oas-output/operations/admin/post_admin_invites_accept.ts +++ b/docs-util/oas-output/operations/admin/post_admin_invites_accept.ts @@ -4,47 +4,7 @@ * summary: Create Invite * description: Create a invite. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -53,7 +13,26 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostInvitesInviteAcceptReq" + * type: object + * description: SUMMARY + * required: + * - email + * - first_name + * - last_name + * properties: + * first_name: + * type: string + * title: first_name + * description: The invite's first name. + * last_name: + * type: string + * title: last_name + * description: The invite's last name. + * email: + * type: string + * title: email + * description: The invite's email. + * format: email * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts b/docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts index e32b68435f..cccec46380 100644 --- a/docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts +++ b/docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,15 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostPaymentsCapturesReq" + * type: object + * description: SUMMARY + * properties: + * amount: + * type: number + * title: amount + * description: The payment's amount. + * required: + * - amount * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts b/docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts index 6760c94df9..596b772a36 100644 --- a/docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts +++ b/docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,15 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostPaymentsRefundsReq" + * type: object + * description: SUMMARY + * properties: + * amount: + * type: number + * title: amount + * description: The payment's amount. + * required: + * - amount * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_price-lists.ts b/docs-util/oas-output/operations/admin/post_admin_price-lists.ts index a7d9dacdd8..05d968d8c7 100644 --- a/docs-util/oas-output/operations/admin/post_admin_price-lists.ts +++ b/docs-util/oas-output/operations/admin/post_admin_price-lists.ts @@ -4,47 +4,7 @@ * summary: Create Price List * description: Create a price list. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -53,7 +13,84 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostPriceListsReq" + * type: object + * description: SUMMARY + * required: + * - title + * - description + * - starts_at + * - ends_at + * - status + * - type + * - rules + * - prices + * properties: + * title: + * type: string + * title: title + * description: The price list's title. + * description: + * type: string + * title: description + * description: The price list's description. + * starts_at: + * type: string + * title: starts_at + * description: The price list's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The price list's ends at. + * status: + * enum: + * - active + * - draft + * type: + * enum: + * - sale + * - override + * prices: + * type: array + * description: The price list's prices. + * items: + * type: object + * description: The price's prices. + * required: + * - currency_code + * - amount + * - variant_id + * - min_quantity + * - max_quantity + * - rules + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * variant_id: + * type: string + * title: variant_id + * description: The price's variant id. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * rules: + * type: object + * description: The price's rules. + * properties: {} + * rules: + * type: object + * description: The price list's rules. + * properties: {} * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts index de63012351..eb819b07a0 100644 --- a/docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,45 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostPriceListsPriceListReq" + * type: object + * description: SUMMARY + * required: + * - title + * - description + * - starts_at + * - ends_at + * - status + * - type + * - rules + * properties: + * title: + * type: string + * title: title + * description: The price list's title. + * description: + * type: string + * title: description + * description: The price list's description. + * starts_at: + * type: string + * title: starts_at + * description: The price list's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The price list's ends at. + * status: + * enum: + * - active + * - draft + * type: + * enum: + * - sale + * - override + * rules: + * type: object + * description: The price list's rules. + * properties: {} * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts new file mode 100644 index 0000000000..2d82583e31 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/price-lists/{id}/prices/batch + * operationId: PostPriceListsIdPricesBatch + * summary: Add Prices to Price List + * description: Add a list of prices to a price list. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The price list's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Price Lists + * 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/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_add.ts deleted file mode 100644 index 02709382ab..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_add.ts +++ /dev/null @@ -1,96 +0,0 @@ -/** - * @oas [post] /admin/price-lists/{id}/prices/batch/add - * operationId: PostPriceListsIdPricesBatchAdd - * summary: Add Adds to Price List - * description: Add a list of adds to a price list. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The price list'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/add' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "prices": [ - * { - * "currency_code": "{value}", - * "amount": 6595965345595392, - * "variant_id": "{value}" - * } - * ] - * }' - * tags: - * - Price Lists - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_remove.ts deleted file mode 100644 index e481a09324..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch_remove.ts +++ /dev/null @@ -1,92 +0,0 @@ -/** - * @oas [post] /admin/price-lists/{id}/prices/batch/remove - * operationId: PostPriceListsIdPricesBatchRemove - * summary: Add Removes to Price List - * description: Add a list of removes to a price list. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The price list'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/remove' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "ids": [ - * "{value}" - * ] - * }' - * tags: - * - Price Lists - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts new file mode 100644 index 0000000000..e5c24f0cc1 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts @@ -0,0 +1,64 @@ +/** + * @oas [post] /admin/price-lists/{id}/products + * operationId: PostPriceListsIdProducts + * summary: Add Products to Price List + * description: Add a list of products to a price list. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The price list's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The price list's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The price list's remove. + * items: + * type: string + * title: remove + * description: The remove's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/price-lists/{id}/products' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Price Lists + * 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/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts b/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts index c451cd4552..088c2ac820 100644 --- a/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts +++ b/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts @@ -4,47 +4,7 @@ * summary: Create Pricing * description: Create a pricing. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -53,7 +13,25 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostPricingRuleTypesReq" + * type: object + * description: SUMMARY + * required: + * - name + * - rule_attribute + * - default_priority + * properties: + * name: + * type: string + * title: name + * description: The pricing's name. + * rule_attribute: + * type: string + * title: rule_attribute + * description: The pricing's rule attribute. + * default_priority: + * type: number + * title: default_priority + * description: The pricing's default priority. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts b/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts index 1394b855b6..0055d76021 100644 --- a/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,25 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostPricingRuleTypesRuleTypeReq" + * type: object + * description: SUMMARY + * properties: + * name: + * type: string + * title: name + * description: The pricing's name. + * rule_attribute: + * type: string + * title: rule_attribute + * description: The pricing's rule attribute. + * default_priority: + * type: number + * title: default_priority + * description: The pricing's default priority. + * required: + * - name + * - rule_attribute + * - default_priority * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_product-categories.ts b/docs-util/oas-output/operations/admin/post_admin_product-categories.ts new file mode 100644 index 0000000000..acce9217cd --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_product-categories.ts @@ -0,0 +1,96 @@ +/** + * @oas [post] /admin/product-categories + * operationId: PostProductCategories + * summary: Create Product Category + * description: Create a product category. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - description + * - handle + * - is_internal + * - is_active + * - parent_category_id + * - metadata + * - rank + * properties: + * name: + * type: string + * title: name + * description: The product category's name. + * description: + * type: string + * title: description + * description: The product category's description. + * handle: + * type: string + * title: handle + * description: The product category's handle. + * is_internal: + * type: boolean + * title: is_internal + * description: The product category's is internal. + * is_active: + * type: boolean + * title: is_active + * description: The product category's is active. + * parent_category_id: + * type: string + * title: parent_category_id + * description: The product category's parent category id. + * metadata: + * type: object + * description: The product category's metadata. + * properties: {} + * rank: + * type: number + * title: rank + * description: The product category's rank. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/product-categories' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Laurel", + * "description": "{value}", + * "handle": "{value}", + * "is_internal": true, + * "is_active": true, + * "parent_category_id": "{value}", + * "metadata": {}, + * "rank": 8919807883739136 + * }' + * tags: + * - Product Categories + * 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/docs-util/oas-output/operations/admin/post_admin_product-categories_[id].ts b/docs-util/oas-output/operations/admin/post_admin_product-categories_[id].ts new file mode 100644 index 0000000000..08dd80ed11 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_product-categories_[id].ts @@ -0,0 +1,102 @@ +/** + * @oas [post] /admin/product-categories/{id} + * operationId: PostProductCategoriesId + * summary: Update a Product Category + * description: Update a product category's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product category's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - description + * - handle + * - is_internal + * - is_active + * - parent_category_id + * - metadata + * - rank + * properties: + * name: + * type: string + * title: name + * description: The product category's name. + * description: + * type: string + * title: description + * description: The product category's description. + * handle: + * type: string + * title: handle + * description: The product category's handle. + * is_internal: + * type: boolean + * title: is_internal + * description: The product category's is internal. + * is_active: + * type: boolean + * title: is_active + * description: The product category's is active. + * parent_category_id: + * type: string + * title: parent_category_id + * description: The product category's parent category id. + * metadata: + * type: object + * description: The product category's metadata. + * properties: {} + * rank: + * type: number + * title: rank + * description: The product category's rank. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/product-categories/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Xzavier", + * "description": "{value}", + * "handle": "{value}", + * "is_internal": true, + * "is_active": true, + * "parent_category_id": "{value}", + * "metadata": {}, + * "rank": 6601863235371008 + * }' + * tags: + * - Product Categories + * 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/docs-util/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts b/docs-util/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts new file mode 100644 index 0000000000..3a967e6587 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/product-categories/{id}/products + * operationId: PostProductCategoriesIdProducts + * summary: Add Products to Product Category + * description: Add a list of products to a product category. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product category's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/product-categories/{id}/products' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Product Categories + * 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/docs-util/oas-output/operations/admin/post_admin_product-types.ts b/docs-util/oas-output/operations/admin/post_admin_product-types.ts new file mode 100644 index 0000000000..e7ba8c36bd --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_product-types.ts @@ -0,0 +1,60 @@ +/** + * @oas [post] /admin/product-types + * operationId: PostProductTypes + * summary: Create Product Type + * description: Create a product type. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - value + * - metadata + * properties: + * value: + * type: string + * title: value + * description: The product type's value. + * metadata: + * type: object + * description: The product type's metadata. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/product-types' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "value": "{value}", + * "metadata": {} + * }' + * tags: + * - Product Types + * 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/docs-util/oas-output/operations/admin/post_admin_product-types_[id].ts b/docs-util/oas-output/operations/admin/post_admin_product-types_[id].ts new file mode 100644 index 0000000000..79764cb651 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_product-types_[id].ts @@ -0,0 +1,66 @@ +/** + * @oas [post] /admin/product-types/{id} + * operationId: PostProductTypesId + * summary: Update a Product Type + * description: Update a product type's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product type's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - value + * - metadata + * properties: + * value: + * type: string + * title: value + * description: The product type's value. + * metadata: + * type: object + * description: The product type's metadata. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/product-types/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "value": "{value}", + * "metadata": {} + * }' + * tags: + * - Product Types + * 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/docs-util/oas-output/operations/admin/post_admin_products.ts b/docs-util/oas-output/operations/admin/post_admin_products.ts index 31caec08d0..a82df6c22a 100644 --- a/docs-util/oas-output/operations/admin/post_admin_products.ts +++ b/docs-util/oas-output/operations/admin/post_admin_products.ts @@ -4,47 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,318 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - title + * - subtitle + * - description + * - is_giftcard + * - discountable + * - images + * - thumbnail + * - handle + * - status + * - type_id + * - collection_id + * - categories + * - tags + * - options + * - variants + * - sales_channels + * - weight + * - length + * - height + * - width + * - hs_code + * - mid_code + * - origin_country + * - material + * - metadata + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * description: + * type: string + * title: description + * description: The product's description. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * required: + * - url + * properties: + * url: + * type: string + * title: url + * description: The image's url. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * handle: + * type: string + * title: handle + * description: The product's handle. + * status: {} + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The category's ID. + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * required: + * - id + * - value + * properties: + * id: + * type: string + * title: id + * description: The tag's ID. + * value: + * type: string + * title: value + * description: The tag's value. + * options: + * type: array + * description: The product's options. + * items: + * type: object + * description: The option's options. + * required: + * - title + * - values + * properties: + * title: + * type: string + * title: title + * description: The option's title. + * values: + * type: array + * description: The option's values. + * items: + * type: string + * title: values + * description: The value's values. + * variants: + * type: array + * description: The product's variants. + * items: + * type: object + * description: The variant's variants. + * required: + * - title + * - sku + * - ean + * - upc + * - barcode + * - hs_code + * - mid_code + * - inventory_quantity + * - allow_backorder + * - manage_inventory + * - variant_rank + * - weight + * - length + * - height + * - width + * - origin_country + * - material + * - metadata + * - prices + * - options + * properties: + * title: + * type: string + * title: title + * description: The variant's title. + * sku: + * type: string + * title: sku + * description: The variant's sku. + * ean: + * type: string + * title: ean + * description: The variant's ean. + * upc: + * type: string + * title: upc + * description: The variant's upc. + * barcode: + * type: string + * title: barcode + * description: The variant's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The variant's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The variant's mid code. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The variant's inventory quantity. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The variant's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The variant's manage inventory. + * variant_rank: + * type: number + * title: variant_rank + * description: The variant's variant rank. + * weight: + * type: number + * title: weight + * description: The variant's weight. + * length: + * type: number + * title: length + * description: The variant's length. + * height: + * type: number + * title: height + * description: The variant's height. + * width: + * type: number + * title: width + * description: The variant's width. + * origin_country: + * type: string + * title: origin_country + * description: The variant's origin country. + * material: + * type: string + * title: material + * description: The variant's material. + * metadata: + * type: object + * description: The variant's metadata. + * properties: {} + * prices: + * type: array + * description: The variant's prices. + * items: + * type: object + * description: The price's prices. + * required: + * - currency_code + * - amount + * - min_quantity + * - max_quantity + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * options: + * type: object + * description: The variant's options. + * properties: {} + * sales_channels: + * type: array + * description: The product's sales channels. + * items: + * type: object + * description: The sales channel's sales channels. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The sales channel's ID. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * material: + * type: string + * title: material + * description: The product's material. + * metadata: + * type: object + * description: The product's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id].ts b/docs-util/oas-output/operations/admin/post_admin_products_[id].ts index dc2287782e..a25541d2ef 100644 --- a/docs-util/oas-output/operations/admin/post_admin_products_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,328 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - length + * - description + * - handle + * - metadata + * - hs_code + * - weight + * - height + * - width + * - origin_country + * - mid_code + * - material + * - thumbnail + * - collection_id + * - tags + * - type_id + * - subtitle + * - images + * - categories + * - sales_channels + * - title + * - discountable + * - options + * - variants + * - status + * properties: + * length: + * type: number + * title: length + * description: The product's length. + * description: + * type: string + * title: description + * description: The product's description. + * handle: + * type: string + * title: handle + * description: The product's handle. + * metadata: + * type: object + * description: The product's metadata. + * properties: {} + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * weight: + * type: number + * title: weight + * description: The product's weight. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * required: + * - id + * - value + * properties: + * id: + * type: string + * title: id + * description: The tag's ID. + * value: + * type: string + * title: value + * description: The tag's value. + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * required: + * - url + * properties: + * url: + * type: string + * title: url + * description: The image's url. + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The category's ID. + * sales_channels: + * type: array + * description: The product's sales channels. + * items: + * type: object + * description: The sales channel's sales channels. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The sales channel's ID. + * title: + * type: string + * title: title + * description: The product's title. + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * options: + * type: array + * description: The product's options. + * items: + * type: object + * description: The option's options. + * required: + * - id + * - title + * - values + * properties: + * id: + * type: string + * title: id + * description: The option's ID. + * title: + * type: string + * title: title + * description: The option's title. + * values: + * type: array + * description: The option's values. + * items: + * type: string + * title: values + * description: The value's values. + * variants: + * type: array + * description: The product's variants. + * items: + * type: object + * description: The variant's variants. + * required: + * - length + * - options + * - metadata + * - sku + * - barcode + * - hs_code + * - weight + * - height + * - width + * - origin_country + * - mid_code + * - material + * - ean + * - upc + * - variant_rank + * - id + * - title + * - prices + * - inventory_quantity + * - allow_backorder + * - manage_inventory + * properties: + * length: + * type: number + * title: length + * description: The variant's length. + * options: + * type: object + * description: The variant's options. + * properties: {} + * metadata: + * type: object + * description: The variant's metadata. + * properties: {} + * sku: + * type: string + * title: sku + * description: The variant's sku. + * barcode: + * type: string + * title: barcode + * description: The variant's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The variant's hs code. + * weight: + * type: number + * title: weight + * description: The variant's weight. + * height: + * type: number + * title: height + * description: The variant's height. + * width: + * type: number + * title: width + * description: The variant's width. + * origin_country: + * type: string + * title: origin_country + * description: The variant's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The variant's mid code. + * material: + * type: string + * title: material + * description: The variant's material. + * ean: + * type: string + * title: ean + * description: The variant's ean. + * upc: + * type: string + * title: upc + * description: The variant's upc. + * variant_rank: + * type: number + * title: variant_rank + * description: The variant's variant rank. + * id: + * type: string + * title: id + * description: The variant's ID. + * title: + * type: string + * title: title + * description: The variant's title. + * prices: + * type: array + * description: The variant's prices. + * items: + * type: object + * description: The price's prices. + * required: + * - id + * - currency_code + * - amount + * - min_quantity + * - max_quantity + * properties: + * id: + * type: string + * title: id + * description: The price's ID. + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The variant's inventory quantity. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The variant's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The variant's manage inventory. + * status: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_options.ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_options.ts index 9e56fd334e..8b89a945d5 100644 --- a/docs-util/oas-output/operations/admin/post_admin_products_[id]_options.ts +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_options.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,23 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - title + * - values + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * values: + * type: array + * description: The product's values. + * items: + * type: string + * title: values + * description: The value's values. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts index fead884b21..e636d3a0af 100644 --- a/docs-util/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts @@ -17,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -85,7 +45,28 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - id + * - title + * - values + * properties: + * id: + * type: string + * title: id + * description: The product's ID. + * title: + * type: string + * title: title + * description: The product's title. + * values: + * type: array + * description: The product's values. + * items: + * type: string + * title: values + * description: The value's values. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants.ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants.ts index 79782f97d1..5c9314dd07 100644 --- a/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants.ts +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,134 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - title + * - sku + * - ean + * - upc + * - barcode + * - hs_code + * - mid_code + * - inventory_quantity + * - allow_backorder + * - manage_inventory + * - variant_rank + * - weight + * - length + * - height + * - width + * - origin_country + * - material + * - metadata + * - prices + * - options + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * sku: + * type: string + * title: sku + * description: The product's sku. + * ean: + * type: string + * title: ean + * description: The product's ean. + * upc: + * type: string + * title: upc + * description: The product's upc. + * barcode: + * type: string + * title: barcode + * description: The product's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The product's inventory quantity. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The product's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The product's manage inventory. + * variant_rank: + * type: number + * title: variant_rank + * description: The product's variant rank. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * material: + * type: string + * title: material + * description: The product's material. + * metadata: + * type: object + * description: The product's metadata. + * properties: {} + * prices: + * type: array + * description: The product's prices. + * items: + * type: object + * description: The price's prices. + * required: + * - currency_code + * - amount + * - min_quantity + * - max_quantity + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * options: + * type: object + * description: The product's options. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts index c19e0dbb00..3408a4b18c 100644 --- a/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts @@ -17,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -85,7 +45,144 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - length + * - options + * - metadata + * - sku + * - barcode + * - hs_code + * - weight + * - height + * - width + * - origin_country + * - mid_code + * - material + * - ean + * - upc + * - variant_rank + * - id + * - title + * - prices + * - inventory_quantity + * - allow_backorder + * - manage_inventory + * properties: + * length: + * type: number + * title: length + * description: The product's length. + * options: + * type: object + * description: The product's options. + * properties: {} + * metadata: + * type: object + * description: The product's metadata. + * properties: {} + * sku: + * type: string + * title: sku + * description: The product's sku. + * barcode: + * type: string + * title: barcode + * description: The product's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * weight: + * type: number + * title: weight + * description: The product's weight. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * ean: + * type: string + * title: ean + * description: The product's ean. + * upc: + * type: string + * title: upc + * description: The product's upc. + * variant_rank: + * type: number + * title: variant_rank + * description: The product's variant rank. + * id: + * type: string + * title: id + * description: The product's ID. + * title: + * type: string + * title: title + * description: The product's title. + * prices: + * type: array + * description: The product's prices. + * items: + * type: object + * description: The price's prices. + * required: + * - id + * - currency_code + * - amount + * - min_quantity + * - max_quantity + * properties: + * id: + * type: string + * title: id + * description: The price's ID. + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The product's inventory quantity. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The product's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The product's manage inventory. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts new file mode 100644 index 0000000000..651c41ae9e --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/products/{id}/variants/batch + * operationId: PostProductsIdVariantsBatch + * summary: Add Variants to Product + * description: Add a list of variants to a product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products/{id}/variants/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Products + * 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/docs-util/oas-output/operations/admin/post_admin_products_batch.ts b/docs-util/oas-output/operations/admin/post_admin_products_batch.ts new file mode 100644 index 0000000000..b3320280eb --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_products_batch.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/products/batch + * operationId: PostProductsBatch + * summary: Create Product + * description: Create a product. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/products/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Products + * 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/docs-util/oas-output/operations/admin/post_admin_promotions.ts b/docs-util/oas-output/operations/admin/post_admin_promotions.ts index 556d570ddf..1c3ebeb31e 100644 --- a/docs-util/oas-output/operations/admin/post_admin_promotions.ts +++ b/docs-util/oas-output/operations/admin/post_admin_promotions.ts @@ -4,47 +4,7 @@ * summary: Create Promotion * description: Create a promotion. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,216 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - code + * - is_automatic + * - type + * - campaign_id + * - campaign + * - application_method + * - rules + * properties: + * code: + * type: string + * title: code + * description: The promotion's code. + * is_automatic: + * type: boolean + * title: is_automatic + * description: The promotion's is automatic. + * type: {} + * campaign_id: + * type: string + * title: campaign_id + * description: The promotion's campaign id. + * campaign: + * type: object + * description: The promotion's campaign. + * required: + * - name + * - campaign_identifier + * - description + * - currency + * - budget + * - starts_at + * - ends_at + * - promotions + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * currency: + * type: string + * title: currency + * description: The campaign's currency. + * budget: + * type: object + * description: The campaign's budget. + * required: + * - type + * - limit + * properties: + * type: {} + * limit: + * type: number + * title: limit + * description: The budget's limit. + * starts_at: + * type: string + * title: starts_at + * description: The campaign's starts at. + * format: date-time + * ends_at: + * type: string + * title: ends_at + * description: The campaign's ends at. + * format: date-time + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * application_method: + * type: object + * description: The promotion's application method. + * required: + * - description + * - value + * - max_quantity + * - type + * - target_type + * - allocation + * - target_rules + * - buy_rules + * - apply_to_quantity + * - buy_rules_min_quantity + * properties: + * description: + * type: string + * title: description + * description: The application method's description. + * value: + * type: number + * title: value + * description: The application method's value. + * max_quantity: + * type: number + * title: max_quantity + * description: The application method's max quantity. + * type: {} + * target_type: {} + * allocation: {} + * target_rules: + * type: array + * description: The application method's target rules. + * items: + * type: object + * description: The target rule's target rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: {} + * description: + * type: string + * title: description + * description: The target rule's description. + * attribute: + * type: string + * title: attribute + * description: The target rule's attribute. + * values: + * type: array + * description: The target rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * buy_rules: + * type: array + * description: The application method's buy rules. + * items: + * type: object + * description: The buy rule's buy rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: {} + * description: + * type: string + * title: description + * description: The buy rule's description. + * attribute: + * type: string + * title: attribute + * description: The buy rule's attribute. + * values: + * type: array + * description: The buy rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * apply_to_quantity: + * type: number + * title: apply_to_quantity + * description: The application method's apply to quantity. + * buy_rules_min_quantity: + * type: number + * title: buy_rules_min_quantity + * description: The application method's buy rules min quantity. + * rules: + * type: array + * description: The promotion's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: {} + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * values: + * type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id].ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id].ts index d076142820..bad83b761d 100644 --- a/docs-util/oas-output/operations/admin/post_admin_promotions_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,254 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostPromotionsPromotionReq" + * type: object + * description: SUMMARY + * properties: + * code: + * type: string + * title: code + * description: The promotion's code. + * is_automatic: + * type: boolean + * title: is_automatic + * description: The promotion's is automatic. + * type: + * enum: + * - standard + * - buyget + * campaign_id: + * type: string + * title: campaign_id + * description: The promotion's campaign id. + * campaign: + * type: object + * description: The promotion's campaign. + * required: + * - name + * - campaign_identifier + * - description + * - currency + * - budget + * - starts_at + * - ends_at + * - promotions + * properties: + * name: + * type: string + * title: name + * description: The campaign's name. + * campaign_identifier: + * type: string + * title: campaign_identifier + * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * currency: + * type: string + * title: currency + * description: The campaign's currency. + * budget: + * type: object + * description: The campaign's budget. + * properties: + * type: + * enum: + * - spend + * - usage + * limit: + * type: number + * title: limit + * description: The budget's limit. + * required: + * - type + * - limit + * 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. + * promotions: + * type: array + * description: The campaign's promotions. + * items: + * type: object + * description: The promotion's promotions. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The promotion's ID. + * application_method: + * type: object + * description: The promotion's application method. + * properties: + * description: + * type: string + * title: description + * description: The application method's description. + * value: + * type: string + * title: value + * description: The application method's value. + * max_quantity: + * type: number + * title: max_quantity + * description: The application method's max quantity. + * type: + * enum: + * - fixed + * - percentage + * target_type: + * enum: + * - order + * - shipping_methods + * - items + * allocation: + * enum: + * - each + * - across + * target_rules: + * type: array + * description: The application method's target rules. + * items: + * type: object + * description: The target rule's target rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The target rule's description. + * attribute: + * type: string + * title: attribute + * description: The target rule's attribute. + * values: + * type: array + * description: The target rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * buy_rules: + * type: array + * description: The application method's buy rules. + * items: + * type: object + * description: The buy rule's buy rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The buy rule's description. + * attribute: + * type: string + * title: attribute + * description: The buy rule's attribute. + * values: + * type: array + * description: The buy rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * apply_to_quantity: + * type: number + * title: apply_to_quantity + * description: The application method's apply to quantity. + * buy_rules_min_quantity: + * type: number + * title: buy_rules_min_quantity + * description: The application method's buy rules min quantity. + * required: + * - description + * - value + * - max_quantity + * - type + * - target_type + * - allocation + * - target_rules + * - buy_rules + * - apply_to_quantity + * - buy_rules_min_quantity + * rules: + * type: array + * description: The promotion's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - operator + * - description + * - attribute + * - values + * properties: + * operator: + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The rule's description. + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * values: + * type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. + * required: + * - code + * - is_automatic + * - type + * - campaign_id + * - campaign + * - application_method + * - rules * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts new file mode 100644 index 0000000000..560d701f07 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/promotions/{id}/buy-rules/batch + * operationId: PostPromotionsIdBuyRulesBatch + * summary: Add Buy Rules to Promotion + * description: Add a list of buy rules to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_add.ts deleted file mode 100644 index 12ab4239f1..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_add.ts +++ /dev/null @@ -1,97 +0,0 @@ -/** - * @oas [post] /admin/promotions/{id}/buy-rules/batch/add - * operationId: PostPromotionsIdBuyRulesBatchAdd - * summary: Add Adds to Promotion - * description: Add a list of adds to a promotion. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The promotion'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch/add' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "rules": [ - * { - * "attribute": "{value}", - * "values": [ - * "{value}" - * ] - * } - * ] - * }' - * tags: - * - Promotions - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_remove.ts deleted file mode 100644 index 016be4f54d..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch_remove.ts +++ /dev/null @@ -1,96 +0,0 @@ -/** - * @oas [post] /admin/promotions/{id}/buy-rules/batch/remove - * operationId: PostPromotionsIdBuyRulesBatchRemove - * summary: Add Removes to Promotion - * description: Add a list of removes to a promotion. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The promotion'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch/remove' - * \ - * - * -H 'x-medusa-access-token: {api_token}' \ - * - * -H 'Content-Type: application/json' \ - * - * --data-raw '{ - * "rule_ids": [ - * "{value}" - * ] - * }' - * tags: - * - Promotions - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts new file mode 100644 index 0000000000..6ac18b4897 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/promotions/{id}/rules/batch + * operationId: PostPromotionsIdRulesBatch + * summary: Add Rules to Promotion + * description: Add a list of rules to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_add.ts deleted file mode 100644 index 3f2a398d4c..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_add.ts +++ /dev/null @@ -1,97 +0,0 @@ -/** - * @oas [post] /admin/promotions/{id}/rules/batch/add - * operationId: PostPromotionsIdRulesBatchAdd - * summary: Add Adds to Promotion - * description: Add a list of adds to a promotion. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The promotion'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/add' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "rules": [ - * { - * "attribute": "{value}", - * "values": [ - * "{value}" - * ] - * } - * ] - * }' - * tags: - * - Promotions - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_remove.ts deleted file mode 100644 index 2653fc3d01..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_remove.ts +++ /dev/null @@ -1,92 +0,0 @@ -/** - * @oas [post] /admin/promotions/{id}/rules/batch/remove - * operationId: PostPromotionsIdRulesBatchRemove - * summary: Add Removes to Promotion - * description: Add a list of removes to a promotion. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The promotion'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/remove' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "rule_ids": [ - * "{value}" - * ] - * }' - * tags: - * - Promotions - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_update.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_update.ts deleted file mode 100644 index 96d3f588ec..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch_update.ts +++ /dev/null @@ -1,98 +0,0 @@ -/** - * @oas [post] /admin/promotions/{id}/rules/batch/update - * operationId: PostPromotionsIdRulesBatchUpdate - * summary: Add Updates to Promotion - * description: Add a list of updates to a promotion. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The promotion'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/update' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "rules": [ - * { - * "id": "id_orjnxCxIQlJAp4", - * "attribute": "{value}", - * "values": [ - * "{value}" - * ] - * } - * ] - * }' - * tags: - * - Promotions - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts new file mode 100644 index 0000000000..0ee0f5e402 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/promotions/{id}/target-rules/batch + * operationId: PostPromotionsIdTargetRulesBatch + * summary: Add Target Rules to Promotion + * description: Add a list of target rules to a promotion. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The promotion's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_add.ts deleted file mode 100644 index 738107d04b..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_add.ts +++ /dev/null @@ -1,101 +0,0 @@ -/** - * @oas [post] /admin/promotions/{id}/target-rules/batch/add - * operationId: PostPromotionsIdTargetRulesBatchAdd - * summary: Add Adds to Promotion - * description: Add a list of adds to a promotion. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The promotion'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch/add' - * \ - * - * -H 'x-medusa-access-token: {api_token}' \ - * - * -H 'Content-Type: application/json' \ - * - * --data-raw '{ - * "rules": [ - * { - * "attribute": "{value}", - * "values": [ - * "{value}" - * ] - * } - * ] - * }' - * tags: - * - Promotions - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_remove.ts b/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_remove.ts deleted file mode 100644 index a323306665..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch_remove.ts +++ /dev/null @@ -1,96 +0,0 @@ -/** - * @oas [post] /admin/promotions/{id}/target-rules/batch/remove - * operationId: PostPromotionsIdTargetRulesBatchRemove - * summary: Add Removes to Promotion - * description: Add a list of removes to a promotion. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The promotion'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq" - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/promotions/{id}/target-rules/batch/remove' \ - * - * -H 'x-medusa-access-token: {api_token}' \ - * - * -H 'Content-Type: application/json' \ - * - * --data-raw '{ - * "rule_ids": [ - * "{value}" - * ] - * }' - * tags: - * - Promotions - * responses: - * "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/docs-util/oas-output/operations/admin/post_admin_regions.ts b/docs-util/oas-output/operations/admin/post_admin_regions.ts index b6c370f479..996e3c5ba6 100644 --- a/docs-util/oas-output/operations/admin/post_admin_regions.ts +++ b/docs-util/oas-output/operations/admin/post_admin_regions.ts @@ -4,47 +4,7 @@ * summary: Create Region * description: Create a region. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,46 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - name + * - currency_code + * - countries + * - automatic_taxes + * - payment_providers + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The region's name. + * currency_code: + * type: string + * title: currency_code + * description: The region's currency code. + * countries: + * type: array + * description: The region's countries. + * items: + * type: string + * title: countries + * description: The country's countries. + * automatic_taxes: + * type: boolean + * title: automatic_taxes + * description: The region's automatic taxes. + * payment_providers: + * type: array + * description: The region's payment providers. + * items: + * type: string + * title: payment_providers + * description: The payment provider's payment providers. + * metadata: + * type: object + * description: The region's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_regions_[id].ts b/docs-util/oas-output/operations/admin/post_admin_regions_[id].ts index 6bf32156b4..6d7e84e86f 100644 --- a/docs-util/oas-output/operations/admin/post_admin_regions_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_regions_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,46 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - name + * - currency_code + * - countries + * - automatic_taxes + * - payment_providers + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The region's name. + * currency_code: + * type: string + * title: currency_code + * description: The region's currency code. + * countries: + * type: array + * description: The region's countries. + * items: + * type: string + * title: countries + * description: The country's countries. + * automatic_taxes: + * type: boolean + * title: automatic_taxes + * description: The region's automatic taxes. + * payment_providers: + * type: array + * description: The region's payment providers. + * items: + * type: string + * title: payment_providers + * description: The payment provider's payment providers. + * metadata: + * type: object + * description: The region's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_reservations.ts b/docs-util/oas-output/operations/admin/post_admin_reservations.ts new file mode 100644 index 0000000000..6744de6379 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_reservations.ts @@ -0,0 +1,84 @@ +/** + * @oas [post] /admin/reservations + * operationId: PostReservations + * summary: Create Reservation + * description: Create a reservation. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - line_item_id + * - location_id + * - inventory_item_id + * - quantity + * - description + * - metadata + * properties: + * 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. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The reservation's inventory item id. + * quantity: + * type: number + * title: quantity + * description: The reservation's quantity. + * description: + * type: string + * title: description + * description: The reservation's description. + * metadata: + * type: object + * description: The reservation's metadata. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/reservations' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "line_item_id": "{value}", + * "location_id": "{value}", + * "inventory_item_id": "{value}", + * "quantity": 3939752942239744, + * "description": "{value}", + * "metadata": {} + * }' + * tags: + * - Reservations + * 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/docs-util/oas-output/operations/admin/post_admin_reservations_[id].ts b/docs-util/oas-output/operations/admin/post_admin_reservations_[id].ts new file mode 100644 index 0000000000..1345bc7868 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_reservations_[id].ts @@ -0,0 +1,78 @@ +/** + * @oas [post] /admin/reservations/{id} + * operationId: PostReservationsId + * summary: Update a Reservation + * description: Update a reservation's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The reservation's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - location_id + * - quantity + * - description + * - metadata + * properties: + * location_id: + * type: string + * title: location_id + * description: The reservation's location id. + * quantity: + * type: number + * title: quantity + * description: The reservation's quantity. + * description: + * type: string + * title: description + * description: The reservation's description. + * metadata: + * type: object + * description: The reservation's metadata. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/reservations/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "location_id": "{value}", + * "quantity": 5781024600489984, + * "description": "{value}", + * "metadata": {} + * }' + * tags: + * - Reservations + * 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/docs-util/oas-output/operations/admin/post_admin_sales-channels.ts b/docs-util/oas-output/operations/admin/post_admin_sales-channels.ts index 4ff7401262..18c66f3eb3 100644 --- a/docs-util/oas-output/operations/admin/post_admin_sales-channels.ts +++ b/docs-util/oas-output/operations/admin/post_admin_sales-channels.ts @@ -4,47 +4,7 @@ * summary: Create Sales Channel * description: Create a sales channel. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +33,30 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - name + * - description + * - is_disabled + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The sales channel's name. + * description: + * type: string + * title: description + * description: The sales channel's description. + * is_disabled: + * type: boolean + * title: is_disabled + * description: The sales channel's is disabled. + * metadata: + * type: object + * description: The sales channel's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id].ts b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id].ts index c6a9cd8a4e..7c75ca2527 100644 --- a/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,30 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - name + * - description + * - is_disabled + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The sales channel's name. + * description: + * type: string + * title: description + * description: The sales channel's description. + * is_disabled: + * type: boolean + * title: is_disabled + * description: The sales channel's is disabled. + * metadata: + * type: object + * description: The sales channel's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts new file mode 100644 index 0000000000..a5fbda6eb8 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts @@ -0,0 +1,64 @@ +/** + * @oas [post] /admin/sales-channels/{id}/products + * operationId: PostSalesChannelsIdProducts + * summary: Add Products to Sales Channel + * description: Add a list of products to a sales channel. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The sales channel's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The sales channel's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The sales channel's remove. + * items: + * type: string + * title: remove + * description: The remove's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/sales-channels/{id}/products' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Sales Channels + * 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/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products_batch_add.ts b/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products_batch_add.ts deleted file mode 100644 index 4c44d9774d..0000000000 --- a/docs-util/oas-output/operations/admin/post_admin_sales-channels_[id]_products_batch_add.ts +++ /dev/null @@ -1,87 +0,0 @@ -/** - * @oas [post] /admin/sales-channels/{id}/products/batch/add - * operationId: PostSalesChannelsIdProductsBatchAdd - * summary: Add Adds to Sales Channel - * description: Add a list of adds to a sales channel. - * x-authenticated: true - * parameters: - * - name: id - * in: path - * description: The sales channel'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: >- - * curl -X POST '{backend_url}/admin/sales-channels/{id}/products/batch/add' - * \ - * - * -H 'x-medusa-access-token: {api_token}' - * tags: - * - Sales Channels - * responses: - * "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" - * requestBody: - * content: - * application/json: - * schema: {} - * -*/ - diff --git a/docs-util/oas-output/operations/admin/post_admin_shipping-options.ts b/docs-util/oas-output/operations/admin/post_admin_shipping-options.ts new file mode 100644 index 0000000000..a6f7683bfa --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_shipping-options.ts @@ -0,0 +1,174 @@ +/** + * @oas [post] /admin/shipping-options + * operationId: PostShippingOptions + * summary: Create Shipping Option + * description: Create a shipping option. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - service_zone_id + * - shipping_profile_id + * - data + * - price_type + * - provider_id + * - type + * - prices + * - rules + * properties: + * name: + * type: string + * title: name + * description: The shipping option's name. + * service_zone_id: + * type: string + * title: service_zone_id + * description: The shipping option's service zone id. + * shipping_profile_id: + * type: string + * title: shipping_profile_id + * description: The shipping option's shipping profile id. + * data: + * type: object + * description: The shipping option's data. + * properties: {} + * price_type: {} + * provider_id: + * type: string + * title: provider_id + * description: The shipping option's provider id. + * type: + * type: object + * description: The shipping option's type. + * required: + * - label + * - description + * - code + * properties: + * label: + * type: string + * title: label + * description: The type's label. + * description: + * type: string + * title: description + * description: The type's description. + * code: + * type: string + * title: code + * description: The type's code. + * prices: + * type: array + * description: The shipping option's prices. + * items: + * oneOf: + * - type: object + * description: The price's prices. + * required: + * - currency_code + * - amount + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * - type: object + * description: The price's prices. + * required: + * - region_id + * - amount + * properties: + * region_id: + * type: string + * title: region_id + * description: The price's region id. + * amount: + * type: number + * title: amount + * description: The price's amount. + * rules: + * type: array + * description: The shipping option's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - operator + * - attribute + * - value + * properties: + * operator: {} + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * value: + * oneOf: + * - type: string + * title: value + * description: The rule's value. + * - type: array + * description: The rule's value. + * items: + * type: string + * title: value + * description: The value's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/shipping-options' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Caitlyn", + * "service_zone_id": "{value}", + * "shipping_profile_id": "{value}", + * "data": {}, + * "provider_id": "{value}", + * "type": { + * "label": "{value}", + * "description": "{value}", + * "code": "{value}" + * }, + * "prices": [], + * "rules": [ + * { + * "attribute": "{value}" + * } + * ] + * }' + * tags: + * - Shipping Options + * 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/docs-util/oas-output/operations/admin/post_admin_shipping-options_[id].ts b/docs-util/oas-output/operations/admin/post_admin_shipping-options_[id].ts new file mode 100644 index 0000000000..32daf7797b --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_shipping-options_[id].ts @@ -0,0 +1,203 @@ +/** + * @oas [post] /admin/shipping-options/{id} + * operationId: PostShippingOptionsId + * summary: Update a Shipping Option + * description: Update a shipping option's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The shipping option's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - data + * - price_type + * - provider_id + * - type + * - prices + * - rules + * properties: + * name: + * type: string + * title: name + * description: The shipping option's name. + * data: + * type: object + * description: The shipping option's data. + * properties: {} + * price_type: {} + * provider_id: + * type: string + * title: provider_id + * description: The shipping option's provider id. + * type: + * type: object + * description: The shipping option's type. + * required: + * - label + * - description + * - code + * properties: + * label: + * type: string + * title: label + * description: The type's label. + * description: + * type: string + * title: description + * description: The type's description. + * code: + * type: string + * title: code + * description: The type's code. + * prices: + * type: array + * description: The shipping option's prices. + * items: + * oneOf: + * - type: object + * description: The price's prices. + * required: + * - id + * - currency_code + * - amount + * properties: + * id: + * type: string + * title: id + * description: The price's ID. + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * - type: object + * description: The price's prices. + * required: + * - id + * - region_id + * - amount + * properties: + * id: + * type: string + * title: id + * description: The price's ID. + * region_id: + * type: string + * title: region_id + * description: The price's region id. + * amount: + * type: number + * title: amount + * description: The price's amount. + * rules: + * type: array + * description: The shipping option's rules. + * items: + * oneOf: + * - type: object + * description: The rule's rules. + * required: + * - operator + * - attribute + * - value + * properties: + * operator: {} + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * value: + * oneOf: + * - type: string + * title: value + * description: The rule's value. + * - type: array + * description: The rule's value. + * items: + * type: string + * title: value + * description: The value's details. + * - type: object + * description: The rule's rules. + * required: + * - id + * - operator + * - attribute + * - value + * properties: + * id: + * type: string + * title: id + * description: The rule's ID. + * operator: {} + * attribute: + * type: string + * title: attribute + * description: The rule's attribute. + * value: + * oneOf: + * - type: string + * title: value + * description: The rule's value. + * - type: array + * description: The rule's value. + * items: + * type: string + * title: value + * description: The value's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/shipping-options/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Delta", + * "data": {}, + * "provider_id": "{value}", + * "type": { + * "label": "{value}", + * "description": "{value}", + * "code": "{value}" + * }, + * "prices": [], + * "rules": [] + * }' + * tags: + * - Shipping Options + * 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/docs-util/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts b/docs-util/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts new file mode 100644 index 0000000000..11b4b2496d --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /admin/shipping-options/{id}/rules/batch + * operationId: PostShippingOptionsIdRulesBatch + * summary: Add Rules to Shipping Option + * description: Add a list of rules to a shipping option. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The shipping option's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/shipping-options/{id}/rules/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Shipping Options + * 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/docs-util/oas-output/operations/admin/post_admin_shipping-profiles.ts b/docs-util/oas-output/operations/admin/post_admin_shipping-profiles.ts new file mode 100644 index 0000000000..c313f654b1 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_shipping-profiles.ts @@ -0,0 +1,66 @@ +/** + * @oas [post] /admin/shipping-profiles + * operationId: PostShippingProfiles + * summary: Create Shipping Profile + * description: Create a shipping profile. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - type + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The shipping profile's name. + * type: + * type: string + * title: type + * description: The shipping profile's type. + * metadata: + * type: object + * description: The shipping profile's metadata. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/shipping-profiles' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Ford", + * "type": "{value}", + * "metadata": {} + * }' + * tags: + * - Shipping Profiles + * 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/docs-util/oas-output/operations/admin/post_admin_stock-locations.ts b/docs-util/oas-output/operations/admin/post_admin_stock-locations.ts index 9a9e9361ee..c2998887b7 100644 --- a/docs-util/oas-output/operations/admin/post_admin_stock-locations.ts +++ b/docs-util/oas-output/operations/admin/post_admin_stock-locations.ts @@ -13,7 +13,71 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostStockLocationsReq" + * type: object + * description: SUMMARY + * required: + * - name + * - address + * - address_id + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The stock location's name. + * address: + * type: object + * description: The stock location's address. + * required: + * - address_1 + * - address_2 + * - company + * - city + * - country_code + * - phone + * - postal_code + * - province + * properties: + * address_1: + * type: string + * title: address_1 + * description: The address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The address's address 2. + * company: + * type: string + * title: company + * description: The address's company. + * city: + * type: string + * title: city + * description: The address's city. + * country_code: + * type: string + * title: country_code + * description: The address's country code. + * phone: + * type: string + * title: phone + * description: The address's phone. + * postal_code: + * type: string + * title: postal_code + * description: The address's postal code. + * province: + * type: string + * title: province + * description: The address's province. + * address_id: + * type: string + * title: address_id + * description: The stock location's address id. + * metadata: + * type: object + * description: The stock location's metadata. + * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -27,8 +91,6 @@ * tags: * - Stock Locations * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id].ts b/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id].ts new file mode 100644 index 0000000000..f2008a49e5 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id].ts @@ -0,0 +1,128 @@ +/** + * @oas [post] /admin/stock-locations/{id} + * operationId: PostStockLocationsId + * summary: Update a Stock Location + * description: Update a stock location's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The stock location's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - address + * - address_id + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The stock location's name. + * address: + * type: object + * description: The stock location's address. + * required: + * - address_1 + * - address_2 + * - company + * - city + * - country_code + * - phone + * - postal_code + * - province + * properties: + * address_1: + * type: string + * title: address_1 + * description: The address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The address's address 2. + * company: + * type: string + * title: company + * description: The address's company. + * city: + * type: string + * title: city + * description: The address's city. + * country_code: + * type: string + * title: country_code + * description: The address's country code. + * phone: + * type: string + * title: phone + * description: The address's phone. + * postal_code: + * type: string + * title: postal_code + * description: The address's postal code. + * province: + * type: string + * title: province + * description: The address's province. + * address_id: + * type: string + * title: address_id + * description: The stock location's address id. + * metadata: + * type: object + * description: The stock location's metadata. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/stock-locations/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Gustave", + * "address": { + * "address_1": "{value}", + * "address_2": "{value}", + * "company": "{value}", + * "city": "{value}", + * "country_code": "{value}", + * "phone": "{value}", + * "postal_code": "{value}", + * "province": "{value}" + * }, + * "address_id": "{value}", + * "metadata": {} + * }' + * tags: + * - Stock Locations + * 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/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts b/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts new file mode 100644 index 0000000000..f86704d749 --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts @@ -0,0 +1,66 @@ +/** + * @oas [post] /admin/stock-locations/{id}/fulfillment-sets + * operationId: PostStockLocationsIdFulfillmentSets + * summary: Add Fulfillment Sets to Stock Location + * description: Add a list of fulfillment sets to a stock location. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The stock location's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - name + * - type + * properties: + * name: + * type: string + * title: name + * description: The stock location's name. + * type: + * type: string + * title: type + * description: The stock location's type. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-sets' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Jeremie", + * "type": "{value}" + * }' + * tags: + * - Stock Locations + * 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/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts b/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts new file mode 100644 index 0000000000..ef62c7f3eb --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts @@ -0,0 +1,64 @@ +/** + * @oas [post] /admin/stock-locations/{id}/sales-channels + * operationId: PostStockLocationsIdSalesChannels + * summary: Add Sales Channels to Stock Location + * description: Add a list of sales channels to a stock location. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The stock location's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The stock location's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The stock location's remove. + * items: + * type: string + * title: remove + * description: The remove's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/stock-locations/{id}/sales-channels' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Stock Locations + * 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/docs-util/oas-output/operations/admin/post_admin_stores_[id].ts b/docs-util/oas-output/operations/admin/post_admin_stores_[id].ts index 9cbdad916e..0cc4aa1398 100644 --- a/docs-util/oas-output/operations/admin/post_admin_stores_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_stores_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -79,7 +39,48 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - name + * - supported_currency_codes + * - default_currency_code + * - default_sales_channel_id + * - default_region_id + * - default_location_id + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The store's name. + * supported_currency_codes: + * type: array + * description: The store's supported currency codes. + * items: + * type: string + * title: supported_currency_codes + * description: The supported currency code's supported currency codes. + * default_currency_code: + * type: string + * title: default_currency_code + * description: The store's default currency code. + * default_sales_channel_id: + * type: string + * title: default_sales_channel_id + * description: The store's default sales channel id. + * default_region_id: + * type: string + * title: default_region_id + * description: The store's default region id. + * default_location_id: + * type: string + * title: default_location_id + * description: The store's default location id. + * metadata: + * type: object + * description: The store's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/admin/post_admin_tax-rates.ts b/docs-util/oas-output/operations/admin/post_admin_tax-rates.ts index c12d398e31..3c3dd42d5e 100644 --- a/docs-util/oas-output/operations/admin/post_admin_tax-rates.ts +++ b/docs-util/oas-output/operations/admin/post_admin_tax-rates.ts @@ -4,47 +4,7 @@ * summary: Create Tax Rate * description: Create a tax rate. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -53,7 +13,64 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostTaxRatesReq" + * type: object + * description: SUMMARY + * required: + * - rate + * - code + * - rules + * - name + * - is_default + * - is_combinable + * - tax_region_id + * - metadata + * properties: + * rate: + * type: number + * title: rate + * description: The tax rate's rate. + * code: + * type: string + * title: code + * description: The tax rate's code. + * rules: + * type: array + * description: The tax rate's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - reference + * - reference_id + * properties: + * reference: + * type: string + * title: reference + * description: The rule's reference. + * reference_id: + * type: string + * title: reference_id + * description: The rule's reference id. + * name: + * type: string + * title: name + * description: The tax rate's name. + * is_default: + * type: boolean + * title: is_default + * description: The tax rate's is default. + * is_combinable: + * type: boolean + * title: is_combinable + * description: The tax rate's is combinable. + * tax_region_id: + * type: string + * title: tax_region_id + * description: The tax rate's tax region id. + * metadata: + * type: object + * description: The tax rate's metadata. + * properties: {} * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id].ts b/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id].ts index 551009cf28..d07a1d4d59 100644 --- a/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,59 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostTaxRatesTaxRateReq" + * type: object + * description: SUMMARY + * properties: + * code: + * type: string + * title: code + * description: The tax rate's code. + * name: + * type: string + * title: name + * description: The tax rate's name. + * rate: + * type: number + * title: rate + * description: The tax rate's rate. + * rules: + * type: array + * description: The tax rate's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - reference + * - reference_id + * properties: + * reference: + * type: string + * title: reference + * description: The rule's reference. + * reference_id: + * type: string + * title: reference_id + * description: The rule's reference id. + * is_default: + * type: boolean + * title: is_default + * description: The tax rate's is default. + * is_combinable: + * type: boolean + * title: is_combinable + * description: The tax rate's is combinable. + * metadata: + * type: object + * description: The tax rate's metadata. + * properties: {} + * required: + * - rate + * - code + * - rules + * - name + * - is_default + * - is_combinable + * - metadata * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts b/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts index 410beb25bc..c18dfa5cb3 100644 --- a/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts +++ b/docs-util/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,20 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostTaxRatesTaxRateRulesReq" + * type: object + * description: SUMMARY + * required: + * - reference + * - reference_id + * properties: + * reference: + * type: string + * title: reference + * description: The tax rate's reference. + * reference_id: + * type: string + * title: reference_id + * description: The tax rate's reference id. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_tax-regions.ts b/docs-util/oas-output/operations/admin/post_admin_tax-regions.ts index 363e55a0f9..0f36787cb1 100644 --- a/docs-util/oas-output/operations/admin/post_admin_tax-regions.ts +++ b/docs-util/oas-output/operations/admin/post_admin_tax-regions.ts @@ -4,47 +4,7 @@ * summary: Create Tax Region * description: Create a tax region. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] @@ -53,7 +13,62 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostTaxRegionsReq" + * type: object + * description: SUMMARY + * required: + * - country_code + * - province_code + * - parent_id + * - default_tax_rate + * - metadata + * properties: + * country_code: + * type: string + * title: country_code + * description: The tax region's country code. + * province_code: + * type: string + * title: province_code + * description: The tax region's province code. + * parent_id: + * type: string + * title: parent_id + * description: The tax region's parent id. + * default_tax_rate: + * type: object + * description: The tax region's default tax rate. + * required: + * - rate + * - code + * - name + * - is_combinable + * - metadata + * properties: + * rate: + * type: number + * title: rate + * description: The default tax rate's rate. + * code: + * type: string + * title: code + * description: The default tax rate's code. + * name: + * type: string + * title: name + * description: The default tax rate's name. + * metadata: + * type: object + * description: The default tax rate's metadata. + * properties: {} + * is_combinable: + * type: string + * enum: + * - "true" + * - "false" + * metadata: + * type: object + * description: The tax region's metadata. + * properties: {} * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_uploads.ts b/docs-util/oas-output/operations/admin/post_admin_uploads.ts new file mode 100644 index 0000000000..8ac0c5ee1f --- /dev/null +++ b/docs-util/oas-output/operations/admin/post_admin_uploads.ts @@ -0,0 +1,37 @@ +/** + * @oas [post] /admin/uploads + * operationId: PostUploads + * summary: Create Upload + * description: Create a upload. + * x-authenticated: true + * parameters: [] + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/uploads' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Uploads + * 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/docs-util/oas-output/operations/admin/post_admin_users.ts b/docs-util/oas-output/operations/admin/post_admin_users.ts index 7d9cad1a9d..08d369ddb8 100644 --- a/docs-util/oas-output/operations/admin/post_admin_users.ts +++ b/docs-util/oas-output/operations/admin/post_admin_users.ts @@ -4,47 +4,7 @@ * summary: Create User * description: Create a user. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * security: * - api_token: [] * - cookie_auth: [] diff --git a/docs-util/oas-output/operations/admin/post_admin_users_[id].ts b/docs-util/oas-output/operations/admin/post_admin_users_[id].ts index 98152ba793..75aad51357 100644 --- a/docs-util/oas-output/operations/admin/post_admin_users_[id].ts +++ b/docs-util/oas-output/operations/admin/post_admin_users_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,25 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminUpdateUserRequest" + * type: object + * description: SUMMARY + * required: + * - first_name + * - last_name + * - avatar_url + * properties: + * first_name: + * type: string + * title: first_name + * description: The user's first name. + * last_name: + * type: string + * title: last_name + * description: The user's last name. + * avatar_url: + * type: string + * title: avatar_url + * description: The user's avatar url. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts index 3ae06eb1b0..ebcbc52dbf 100644 --- a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts +++ b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,17 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostWorkflowsRunReq" + * type: object + * description: SUMMARY + * properties: + * input: {} + * transaction_id: + * type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * required: + * - input + * - transaction_id * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts index a419e729a3..c63fd088c3 100644 --- a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts +++ b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,29 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostWorkflowsAsyncResponseReq" + * type: object + * description: SUMMARY + * required: + * - transaction_id + * - step_id + * - response + * - compensate_input + * - action + * properties: + * transaction_id: + * type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * step_id: + * type: string + * title: step_id + * description: The workflows execution's step id. + * response: {} + * compensate_input: {} + * action: + * enum: + * - invoke + * - compensate * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts index e5849d313e..68ed85b646 100644 --- a/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts +++ b/docs-util/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * security: * - api_token: [] * - cookie_auth: [] @@ -59,7 +19,29 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminPostWorkflowsAsyncResponseReq" + * type: object + * description: SUMMARY + * required: + * - transaction_id + * - step_id + * - response + * - compensate_input + * - action + * properties: + * transaction_id: + * type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * step_id: + * type: string + * title: step_id + * description: The workflows execution's step id. + * response: {} + * compensate_input: {} + * action: + * enum: + * - invoke + * - compensate * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/auth/get_auth_[scope]_[auth_provider].ts b/docs-util/oas-output/operations/auth/get_auth_[scope]_[auth_provider].ts index 921fa1c0e1..ac4e4db8c3 100644 --- a/docs-util/oas-output/operations/auth/get_auth_[scope]_[auth_provider].ts +++ b/docs-util/oas-output/operations/auth/get_auth_[scope]_[auth_provider].ts @@ -25,8 +25,6 @@ * tags: * - "[scope]" * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -39,6 +37,10 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * requestBody: + * content: + * application/json: + * schema: {} * */ diff --git a/docs-util/oas-output/operations/auth/get_auth_[scope]_[auth_provider]_callback.ts b/docs-util/oas-output/operations/auth/get_auth_[scope]_[auth_provider]_callback.ts index f0e91ebfcd..84def02249 100644 --- a/docs-util/oas-output/operations/auth/get_auth_[scope]_[auth_provider]_callback.ts +++ b/docs-util/oas-output/operations/auth/get_auth_[scope]_[auth_provider]_callback.ts @@ -25,8 +25,6 @@ * tags: * - "[scope]" * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -39,6 +37,10 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * requestBody: + * content: + * application/json: + * schema: {} * */ diff --git a/docs-util/oas-output/operations/auth/post_auth_[scope]_[auth_provider].ts b/docs-util/oas-output/operations/auth/post_auth_[scope]_[auth_provider].ts index caa469d3e9..55dde1b7eb 100644 --- a/docs-util/oas-output/operations/auth/post_auth_[scope]_[auth_provider].ts +++ b/docs-util/oas-output/operations/auth/post_auth_[scope]_[auth_provider].ts @@ -24,8 +24,6 @@ * tags: * - "[scope]" * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -38,6 +36,10 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * requestBody: + * content: + * application/json: + * schema: {} * */ diff --git a/docs-util/oas-output/operations/auth/post_auth_[scope]_[auth_provider]_callback.ts b/docs-util/oas-output/operations/auth/post_auth_[scope]_[auth_provider]_callback.ts index 2f459ca358..6384e87e0c 100644 --- a/docs-util/oas-output/operations/auth/post_auth_[scope]_[auth_provider]_callback.ts +++ b/docs-util/oas-output/operations/auth/post_auth_[scope]_[auth_provider]_callback.ts @@ -24,8 +24,6 @@ * tags: * - "[scope]" * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -38,6 +36,10 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * requestBody: + * content: + * application/json: + * schema: {} * */ diff --git a/docs-util/oas-output/operations/auth/post_auth_session.ts b/docs-util/oas-output/operations/auth/post_auth_session.ts index 0aa63c7216..439565ac24 100644 --- a/docs-util/oas-output/operations/auth/post_auth_session.ts +++ b/docs-util/oas-output/operations/auth/post_auth_session.ts @@ -4,47 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/hooks/post_hooks_payment_[provider].ts b/docs-util/oas-output/operations/hooks/post_hooks_payment_[provider].ts index c390447490..52edfaeee1 100644 --- a/docs-util/oas-output/operations/hooks/post_hooks_payment_[provider].ts +++ b/docs-util/oas-output/operations/hooks/post_hooks_payment_[provider].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts b/docs-util/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts index 9e4c384bed..791863aa52 100644 --- a/docs-util/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts +++ b/docs-util/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts @@ -18,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/delete_store_carts_[id]_promotions.ts b/docs-util/oas-output/operations/store/delete_store_carts_[id]_promotions.ts index dd699357d4..513a59bbc8 100644 --- a/docs-util/oas-output/operations/store/delete_store_carts_[id]_promotions.ts +++ b/docs-util/oas-output/operations/store/delete_store_carts_[id]_promotions.ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL @@ -74,7 +34,18 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - promo_codes + * properties: + * promo_codes: + * type: array + * description: The cart's promo codes. + * items: + * type: string + * title: promo_codes + * description: The promo code's promo codes. * */ diff --git a/docs-util/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts b/docs-util/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts index 03fefd2b32..45a57c12d0 100644 --- a/docs-util/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts +++ b/docs-util/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/get_store_carts_[id].ts b/docs-util/oas-output/operations/store/get_store_carts_[id].ts index 13e0239f36..04d3e793ff 100644 --- a/docs-util/oas-output/operations/store/get_store_carts_[id].ts +++ b/docs-util/oas-output/operations/store/get_store_carts_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/get_store_collections.ts b/docs-util/oas-output/operations/store/get_store_collections.ts new file mode 100644 index 0000000000..a4cb357bbb --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_collections.ts @@ -0,0 +1,32 @@ +/** + * @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. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/collections' + * tags: + * - Collections + * 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/docs-util/oas-output/operations/store/get_store_collections_[id].ts b/docs-util/oas-output/operations/store/get_store_collections_[id].ts new file mode 100644 index 0000000000..ffeaab80ac --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_collections_[id].ts @@ -0,0 +1,38 @@ +/** + * @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. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The collection's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/collections/{id}' + * tags: + * - Collections + * 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/docs-util/oas-output/operations/store/get_store_currencies.ts b/docs-util/oas-output/operations/store/get_store_currencies.ts index 7513ba0edc..6a6c47fae3 100644 --- a/docs-util/oas-output/operations/store/get_store_currencies.ts +++ b/docs-util/oas-output/operations/store/get_store_currencies.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/get_store_currencies_[code].ts b/docs-util/oas-output/operations/store/get_store_currencies_[code].ts index 70179a2250..140dfeef9c 100644 --- a/docs-util/oas-output/operations/store/get_store_currencies_[code].ts +++ b/docs-util/oas-output/operations/store/get_store_currencies_[code].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/get_store_customers_me.ts b/docs-util/oas-output/operations/store/get_store_customers_me.ts index 39b422af6b..92a0702d1a 100644 --- a/docs-util/oas-output/operations/store/get_store_customers_me.ts +++ b/docs-util/oas-output/operations/store/get_store_customers_me.ts @@ -5,47 +5,7 @@ * 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: 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL @@ -68,7 +28,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The customer's fields. * */ diff --git a/docs-util/oas-output/operations/store/get_store_customers_me_addresses.ts b/docs-util/oas-output/operations/store/get_store_customers_me_addresses.ts index 99bc4dba69..bdbf40f928 100644 --- a/docs-util/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/docs-util/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -5,47 +5,7 @@ * 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: 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL @@ -68,7 +28,80 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - metadata + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - address_name + * - is_default_shipping + * - is_default_billing + * properties: + * metadata: + * type: object + * description: The customer's metadata. + * properties: {} + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * company: + * type: string + * title: company + * description: The customer's company. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. * */ diff --git a/docs-util/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts b/docs-util/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts index cbfa9a096e..ec084a94a3 100644 --- a/docs-util/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts +++ b/docs-util/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL @@ -74,7 +34,15 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - fields + * properties: + * fields: + * type: string + * title: fields + * description: The customer's fields. * */ diff --git a/docs-util/oas-output/operations/store/get_store_product-categories.ts b/docs-util/oas-output/operations/store/get_store_product-categories.ts new file mode 100644 index 0000000000..c626f9645b --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_product-categories.ts @@ -0,0 +1,33 @@ +/** + * @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. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/product-categories' + * tags: + * - Product Categories + * 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/docs-util/oas-output/operations/store/get_store_product-categories_[id].ts b/docs-util/oas-output/operations/store/get_store_product-categories_[id].ts new file mode 100644 index 0000000000..19cb6688b6 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_product-categories_[id].ts @@ -0,0 +1,68 @@ +/** + * @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. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The product category's ID. + * required: true + * schema: + * type: string + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - fields + * - include_ancestors_tree + * - include_descendants_tree + * properties: + * fields: + * type: string + * title: fields + * description: The product category's fields. + * include_ancestors_tree: + * type: boolean + * title: include_ancestors_tree + * description: The product category's include ancestors tree. + * include_descendants_tree: + * type: boolean + * title: include_descendants_tree + * description: The product category's include descendants tree. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/store/product-categories/{id}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "fields": "{value}", + * "include_ancestors_tree": true, + * "include_descendants_tree": false + * }' + * tags: + * - Product Categories + * 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/docs-util/oas-output/operations/store/get_store_products.ts b/docs-util/oas-output/operations/store/get_store_products.ts new file mode 100644 index 0000000000..7f19994ce0 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_products.ts @@ -0,0 +1,32 @@ +/** + * @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. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/products' + * tags: + * - Products + * 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/docs-util/oas-output/operations/store/get_store_products_[id].ts b/docs-util/oas-output/operations/store/get_store_products_[id].ts new file mode 100644 index 0000000000..9c516506f5 --- /dev/null +++ b/docs-util/oas-output/operations/store/get_store_products_[id].ts @@ -0,0 +1,38 @@ +/** + * @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. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/products/{id}' + * tags: + * - Products + * 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/docs-util/oas-output/operations/store/get_store_regions.ts b/docs-util/oas-output/operations/store/get_store_regions.ts index 729fe8dda2..32332290ec 100644 --- a/docs-util/oas-output/operations/store/get_store_regions.ts +++ b/docs-util/oas-output/operations/store/get_store_regions.ts @@ -5,47 +5,7 @@ * 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 - * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/get_store_regions_[id].ts b/docs-util/oas-output/operations/store/get_store_regions_[id].ts index 8c93830d61..f37cd5899e 100644 --- a/docs-util/oas-output/operations/store/get_store_regions_[id].ts +++ b/docs-util/oas-output/operations/store/get_store_regions_[id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/get_store_regions_[id]_payment-providers.ts b/docs-util/oas-output/operations/store/get_store_regions_[id]_payment-providers.ts deleted file mode 100644 index 8fd7a8b99b..0000000000 --- a/docs-util/oas-output/operations/store/get_store_regions_[id]_payment-providers.ts +++ /dev/null @@ -1,81 +0,0 @@ -/** - * @oas [get] /store/regions/{id}/payment-providers - * operationId: GetRegionsIdPaymentProviders - * summary: List Payment Providers - * description: Retrieve a list of payment providers in a region. The payment - * providers can be filtered by fields like FILTER FIELDS. The payment providers - * can also be paginated. - * x-authenticated: false - * parameters: - * - name: id - * in: path - * description: The region'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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: curl '{backend_url}/store/regions/{id}/payment-providers' - * tags: - * - Regions - * responses: - * "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" - * requestBody: - * content: - * application/json: - * schema: {} - * -*/ - diff --git a/docs-util/oas-output/operations/store/get_store_shipping-options_[cart_id].ts b/docs-util/oas-output/operations/store/get_store_shipping-options_[cart_id].ts index f66609c54b..a9f8e322c0 100644 --- a/docs-util/oas-output/operations/store/get_store_shipping-options_[cart_id].ts +++ b/docs-util/oas-output/operations/store/get_store_shipping-options_[cart_id].ts @@ -12,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/post_store_carts.ts b/docs-util/oas-output/operations/store/post_store_carts.ts index c75a443343..f16d3ed325 100644 --- a/docs-util/oas-output/operations/store/post_store_carts.ts +++ b/docs-util/oas-output/operations/store/post_store_carts.ts @@ -4,47 +4,7 @@ * summary: Create Cart * description: Create a cart. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id].ts b/docs-util/oas-output/operations/store/post_store_carts_[id].ts index 1ce18634d1..7ea397d04e 100644 --- a/docs-util/oas-output/operations/store/post_store_carts_[id].ts +++ b/docs-util/oas-output/operations/store/post_store_carts_[id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items.ts index 5a5d62bc0b..04b6b31cb7 100644 --- a/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items.ts +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL @@ -73,7 +33,25 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - variant_id + * - quantity + * - metadata + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The cart's variant id. + * quantity: + * type: number + * title: quantity + * description: The cart's quantity. + * metadata: + * type: object + * description: The cart's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts index b9e80ddb2e..47cf7ef05a 100644 --- a/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts @@ -17,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL @@ -79,7 +39,20 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - quantity + * - metadata + * properties: + * quantity: + * type: number + * title: quantity + * description: The cart's quantity. + * metadata: + * type: object + * description: The cart's metadata. + * properties: {} * */ diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts index 90de390484..2dc374ff1b 100644 --- a/docs-util/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL @@ -73,7 +33,169 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - region_id + * - email + * - billing_address + * - shipping_address + * - sales_channel_id + * - metadata + * - promo_codes + * properties: + * region_id: + * type: string + * title: region_id + * description: The cart's region id. + * email: + * type: string + * title: email + * description: The cart's email. + * format: email + * billing_address: + * oneOf: + * - type: string + * title: billing_address + * description: The cart's billing address. + * - type: object + * description: The cart's billing address. + * required: + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - metadata + * properties: + * 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. + * properties: {} + * shipping_address: + * oneOf: + * - type: string + * title: shipping_address + * description: The cart's shipping address. + * - type: object + * description: The cart's shipping address. + * required: + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - metadata + * properties: + * first_name: + * type: string + * title: first_name + * description: The shipping address's first name. + * last_name: + * type: string + * title: last_name + * description: The shipping address's last name. + * phone: + * type: string + * title: phone + * description: The shipping address's phone. + * company: + * type: string + * title: company + * description: The shipping address's company. + * address_1: + * type: string + * title: address_1 + * description: The shipping address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The shipping address's address 2. + * city: + * type: string + * title: city + * description: The shipping address's city. + * country_code: + * type: string + * title: country_code + * description: The shipping address's country code. + * province: + * type: string + * title: province + * description: The shipping address's province. + * postal_code: + * type: string + * title: postal_code + * description: The shipping address's postal code. + * metadata: + * type: object + * description: The shipping address's metadata. + * properties: {} + * sales_channel_id: + * type: string + * title: sales_channel_id + * description: The cart's sales channel id. + * metadata: + * type: object + * description: The cart's metadata. + * properties: {} + * promo_codes: + * type: array + * description: The cart's promo codes. + * items: + * type: string + * title: promo_codes + * description: The promo code's promo codes. * */ diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_promotions.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_promotions.ts index d737edb90e..bc964f2bab 100644 --- a/docs-util/oas-output/operations/store/post_store_carts_[id]_promotions.ts +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_promotions.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL @@ -73,7 +33,18 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - promo_codes + * properties: + * promo_codes: + * type: array + * description: The cart's promo codes. + * items: + * type: string + * title: promo_codes + * description: The promo code's promo codes. * */ diff --git a/docs-util/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts new file mode 100644 index 0000000000..85ed6c0bba --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts @@ -0,0 +1,61 @@ +/** + * @oas [post] /store/carts/{id}/shipping-methods + * operationId: PostCartsIdShippingMethods + * summary: Add Shipping Methods to Cart + * description: Add a list of shipping methods to a cart. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The cart's ID. + * required: true + * schema: + * type: string + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - option_id + * - data + * properties: + * option_id: + * type: string + * title: option_id + * description: The cart's option id. + * data: + * type: object + * description: The cart's data. + * properties: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "option_id": "{value}", + * "data": {} + * }' + * tags: + * - Carts + * 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/docs-util/oas-output/operations/store/post_store_carts_[id]_taxes.ts b/docs-util/oas-output/operations/store/post_store_carts_[id]_taxes.ts index afed88425f..2af6457a74 100644 --- a/docs-util/oas-output/operations/store/post_store_carts_[id]_taxes.ts +++ b/docs-util/oas-output/operations/store/post_store_carts_[id]_taxes.ts @@ -11,51 +11,19 @@ * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * requestBody: * content: * application/json: * schema: - * $ref: "#/components/schemas/StorePostCartsCartTaxesReq" + * type: object + * description: SUMMARY + * properties: + * fields: + * type: string + * title: fields + * description: The cart's fields. + * required: + * - fields * x-codeSamples: * - lang: Shell * label: cURL diff --git a/docs-util/oas-output/operations/store/post_store_customers.ts b/docs-util/oas-output/operations/store/post_store_customers.ts index 3fa8117252..80a628031f 100644 --- a/docs-util/oas-output/operations/store/post_store_customers.ts +++ b/docs-util/oas-output/operations/store/post_store_customers.ts @@ -4,47 +4,7 @@ * summary: Create Customer * description: Create a customer. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL @@ -67,7 +27,36 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - email + * - company_name + * - first_name + * - last_name + * - phone + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. * */ diff --git a/docs-util/oas-output/operations/store/post_store_customers_me.ts b/docs-util/oas-output/operations/store/post_store_customers_me.ts new file mode 100644 index 0000000000..d8e7f68ced --- /dev/null +++ b/docs-util/oas-output/operations/store/post_store_customers_me.ts @@ -0,0 +1,67 @@ +/** + * @oas [post] /store/customers/me + * operationId: PostCustomersMe + * summary: Create Customer + * description: Create a customer. + * x-authenticated: false + * parameters: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - company_name + * - first_name + * - last_name + * - phone + * properties: + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/store/customers/me' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "company_name": "{value}", + * "first_name": "{value}", + * "last_name": "{value}", + * "phone": "{value}" + * }' + * tags: + * - Customers + * 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/docs-util/oas-output/operations/store/post_store_customers_me_addresses.ts b/docs-util/oas-output/operations/store/post_store_customers_me_addresses.ts index 0ee6801db6..10161e6571 100644 --- a/docs-util/oas-output/operations/store/post_store_customers_me_addresses.ts +++ b/docs-util/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -4,47 +4,7 @@ * summary: Create Customer * description: Create a customer. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. + * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL @@ -67,7 +27,80 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - metadata + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - address_name + * - is_default_shipping + * - is_default_billing + * properties: + * metadata: + * type: object + * description: The customer's metadata. + * properties: {} + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * company: + * type: string + * title: company + * description: The customer's company. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. * */ diff --git a/docs-util/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/docs-util/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts index 0543238cf6..39ba2c8d0d 100644 --- a/docs-util/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts +++ b/docs-util/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * x-codeSamples: * - lang: Shell * label: cURL @@ -73,7 +33,80 @@ * requestBody: * content: * application/json: - * schema: {} + * schema: + * type: object + * required: + * - metadata + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - address_name + * - is_default_shipping + * - is_default_billing + * properties: + * metadata: + * type: object + * description: The customer's metadata. + * properties: {} + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * company: + * type: string + * title: company + * description: The customer's company. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. * */ diff --git a/docs-util/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts b/docs-util/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts index 7a3394a7ac..69a95b9701 100644 --- a/docs-util/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts +++ b/docs-util/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts @@ -11,46 +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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - 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: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. * requestBody: * content: * application/json: diff --git a/docs-util/oas-output/schemas/AdminDeletePricingRuleTypesRuleTypeReq.ts b/docs-util/oas-output/schemas/AdminDeletePricingRuleTypesRuleTypeReq.ts deleted file mode 100644 index 9bff34e06f..0000000000 --- a/docs-util/oas-output/schemas/AdminDeletePricingRuleTypesRuleTypeReq.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * @schema AdminDeletePricingRuleTypesRuleTypeReq - * type: object - * description: SUMMARY - * x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminGetPricingRuleTypesParams.ts b/docs-util/oas-output/schemas/AdminGetPricingRuleTypesParams.ts deleted file mode 100644 index 10781e502c..0000000000 --- a/docs-util/oas-output/schemas/AdminGetPricingRuleTypesParams.ts +++ /dev/null @@ -1,36 +0,0 @@ -/** - * @schema AdminGetPricingRuleTypesParams - * type: object - * description: SUMMARY - * x-schemaName: AdminGetPricingRuleTypesParams - * properties: - * rule_attribute: - * type: array - * description: The pricing's rule attribute. - * items: - * type: string - * title: rule_attribute - * description: The rule attribute's details. - * expand: - * type: string - * title: expand - * description: The pricing's expand. - * fields: - * type: string - * title: fields - * description: The pricing's fields. - * offset: - * type: number - * title: offset - * description: The pricing's offset. - * limit: - * type: number - * title: limit - * description: The pricing's limit. - * order: - * type: string - * title: order - * description: The pricing's order. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminGetPricingRuleTypesRuleTypeParams.ts b/docs-util/oas-output/schemas/AdminGetPricingRuleTypesRuleTypeParams.ts deleted file mode 100644 index c7771f5345..0000000000 --- a/docs-util/oas-output/schemas/AdminGetPricingRuleTypesRuleTypeParams.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * @schema AdminGetPricingRuleTypesRuleTypeParams - * type: object - * description: SUMMARY - * x-schemaName: AdminGetPricingRuleTypesRuleTypeParams - * properties: - * expand: - * type: string - * title: expand - * description: The pricing's expand. - * fields: - * type: string - * title: fields - * description: The pricing's fields. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminGetProductsParams.ts b/docs-util/oas-output/schemas/AdminGetProductsParams.ts deleted file mode 100644 index 4f2500c118..0000000000 --- a/docs-util/oas-output/schemas/AdminGetProductsParams.ts +++ /dev/null @@ -1,8347 +0,0 @@ -/** - * @schema AdminGetProductsParams - * type: object - * description: SUMMARY - * x-schemaName: AdminGetProductsParams - * properties: - * q: - * type: string - * title: q - * description: The product's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The product's ID. - * - type: array - * description: The product's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * status: - * type: array - * description: The product's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * title: - * type: string - * title: title - * description: The product's title. - * handle: - * type: string - * title: handle - * description: The product's handle. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The product's is giftcard. - * price_list_id: - * type: array - * description: The product's price list id. - * items: - * type: string - * title: price_list_id - * description: The price list id's details. - * sales_channel_id: - * type: array - * description: The product's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * collection_id: - * type: array - * description: The product's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * tags: - * type: array - * description: The product's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. - * type_id: - * type: array - * description: The product's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * variants: - * type: object - * description: The product's variants. - * properties: {} - * created_at: - * type: object - * description: The product's created at. - * properties: - * $and: - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $and's exec. - * properties: {} - * test: - * type: object - * description: The $and's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $and's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $and's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $and's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $and's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $and's @matchall@2360. - * properties: {} - * - 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * properties: {} - * - 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 - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $and's $not. - * properties: {} - * - 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 - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $and's exec. - * properties: {} - * test: - * type: object - * description: The $and's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $and's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $and's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $and's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $and's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $and's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $or's exec. - * properties: {} - * test: - * type: object - * description: The $or's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $or's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $or's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $or's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $or's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $or's @matchall@2360. - * properties: {} - * - 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * properties: {} - * - 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 - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $or's $not. - * properties: {} - * - 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 - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $or's exec. - * properties: {} - * test: - * type: object - * description: The $or's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $or's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $or's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $or's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $or's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $or's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * properties: {} - * test: - * type: object - * description: The $eq's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $eq's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $eq's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $eq's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $eq's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $eq's @matchall@2360. - * properties: {} - * - type: array - * description: The created at's $eq. - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * properties: {} - * test: - * type: object - * description: The $eq's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $eq's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $eq's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $eq's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $eq's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $eq's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * properties: {} - * test: - * type: object - * description: The $ne's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $ne's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $ne's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $ne's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $ne's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $ne's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $in's exec. - * properties: {} - * test: - * type: object - * description: The $in's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $in's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $in's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $in's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $in's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $in's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * properties: {} - * test: - * type: object - * description: The $nin's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $nin's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $nin's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $nin's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $nin's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $nin's @matchall@2360. - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The created at's $not. - * - type: object - * description: The created at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $not's exec. - * properties: {} - * test: - * type: object - * description: The $not's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $not's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $not's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $not's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $not's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $not's @matchall@2360. - * properties: {} - * - type: object - * description: The created at's $not. - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The $not's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp - * properties: {} - * $in: - * type: array - * description: The $not's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * properties: {} - * $nin: - * type: array - * description: The $not's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $not's details. - * properties: {} - * - type: array - * description: The $not's details. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The $not's $like. - * $re: - * type: string - * title: $re - * description: The $not's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $not's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $not's $fulltext. - * $overlap: - * type: array - * description: The $not's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $not's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $not's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $not's $exists. - * - type: array - * description: The created at's $not. - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $not's exec. - * properties: {} - * test: - * type: object - * description: The $not's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $not's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $not's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $not's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $not's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $not's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * properties: {} - * test: - * type: object - * description: The $gt's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $gt's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $gt's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $gt's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $gt's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $gt's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * properties: {} - * test: - * type: object - * description: The $gte's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $gte's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $gte's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $gte's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $gte's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $gte's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * properties: {} - * test: - * type: object - * description: The $lt's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $lt's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $lt's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $lt's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $lt's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $lt's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * properties: {} - * test: - * type: object - * description: The $lte's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $lte's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $lte's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $lte's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $lte's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $lte's @matchall@2360. - * properties: {} - * $like: - * type: string - * title: $like - * description: The created at's $like. - * $re: - * type: string - * title: $re - * description: The created at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The created at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The created at's $fulltext. - * $overlap: - * type: array - * description: The created at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The created at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The created at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The created at's $exists. - * updated_at: - * type: object - * description: The product's updated at. - * properties: - * $and: - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $and's exec. - * properties: {} - * test: - * type: object - * description: The $and's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $and's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $and's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $and's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $and's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $and's @matchall@2360. - * properties: {} - * - 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * properties: {} - * - 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 - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $and's $not. - * properties: {} - * - 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 - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $and's exec. - * properties: {} - * test: - * type: object - * description: The $and's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $and's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $and's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $and's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $and's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $and's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $or's exec. - * properties: {} - * test: - * type: object - * description: The $or's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $or's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $or's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $or's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $or's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $or's @matchall@2360. - * properties: {} - * - 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * properties: {} - * - 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 - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $or's $not. - * properties: {} - * - 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 - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $or's exec. - * properties: {} - * test: - * type: object - * description: The $or's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $or's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $or's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $or's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $or's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $or's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * properties: {} - * test: - * type: object - * description: The $eq's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $eq's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $eq's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $eq's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $eq's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $eq's @matchall@2360. - * properties: {} - * - type: array - * description: The updated at's $eq. - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * properties: {} - * test: - * type: object - * description: The $eq's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $eq's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $eq's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $eq's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $eq's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $eq's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * properties: {} - * test: - * type: object - * description: The $ne's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $ne's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $ne's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $ne's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $ne's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $ne's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $in's exec. - * properties: {} - * test: - * type: object - * description: The $in's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $in's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $in's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $in's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $in's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $in's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * properties: {} - * test: - * type: object - * description: The $nin's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $nin's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $nin's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $nin's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $nin's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $nin's @matchall@2360. - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The updated at's $not. - * - type: object - * description: The updated at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $not's exec. - * properties: {} - * test: - * type: object - * description: The $not's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $not's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $not's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $not's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $not's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $not's @matchall@2360. - * properties: {} - * - type: object - * description: The updated at's $not. - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The $not's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp - * properties: {} - * $in: - * type: array - * description: The $not's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * properties: {} - * $nin: - * type: array - * description: The $not's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $not's details. - * properties: {} - * - type: array - * description: The $not's details. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The $not's $like. - * $re: - * type: string - * title: $re - * description: The $not's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $not's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $not's $fulltext. - * $overlap: - * type: array - * description: The $not's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $not's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $not's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $not's $exists. - * - type: array - * description: The updated at's $not. - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $not's exec. - * properties: {} - * test: - * type: object - * description: The $not's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $not's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $not's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $not's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $not's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $not's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * properties: {} - * test: - * type: object - * description: The $gt's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $gt's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $gt's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $gt's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $gt's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $gt's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * properties: {} - * test: - * type: object - * description: The $gte's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $gte's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $gte's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $gte's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $gte's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $gte's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * properties: {} - * test: - * type: object - * description: The $lt's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $lt's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $lt's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $lt's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $lt's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $lt's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * properties: {} - * test: - * type: object - * description: The $lte's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $lte's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $lte's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $lte's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $lte's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $lte's @matchall@2360. - * properties: {} - * $like: - * type: string - * title: $like - * description: The updated at's $like. - * $re: - * type: string - * title: $re - * description: The updated at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The updated at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The updated at's $fulltext. - * $overlap: - * type: array - * description: The updated at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The updated at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The updated at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The updated at's $exists. - * deleted_at: - * type: object - * description: The product's deleted at. - * properties: - * $and: - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $and's exec. - * properties: {} - * test: - * type: object - * description: The $and's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $and's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $and's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $and's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $and's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $and's @matchall@2360. - * properties: {} - * - 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $and's $eq. - * - type: object - * description: The $and's $eq. - * x-schemaName: RegExp - * properties: {} - * - 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 - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $and's $ne. - * - type: object - * description: The $and's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $and's $not. - * - type: object - * description: The $and's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $and's $not. - * properties: {} - * - 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 - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $and's $gt. - * - type: object - * description: The $and's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $and's $gte. - * - type: object - * description: The $and's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $and's $lt. - * - type: object - * description: The $and's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $and's $lte. - * - type: object - * description: The $and's $lte. - * x-schemaName: RegExp - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $and's exec. - * properties: {} - * test: - * type: object - * description: The $and's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $and's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $and's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $and's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $and's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $and's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $or's exec. - * properties: {} - * test: - * type: object - * description: The $or's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $or's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $or's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $or's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $or's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $or's @matchall@2360. - * properties: {} - * - 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $or's $eq. - * - type: object - * description: The $or's $eq. - * x-schemaName: RegExp - * properties: {} - * - 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 - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $or's $ne. - * - type: object - * description: The $or's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $or's $not. - * - type: object - * description: The $or's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $or's $not. - * properties: {} - * - 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 - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $or's $gt. - * - type: object - * description: The $or's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $or's $gte. - * - type: object - * description: The $or's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $or's $lt. - * - type: object - * description: The $or's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $or's $lte. - * - type: object - * description: The $or's $lte. - * x-schemaName: RegExp - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $or's exec. - * properties: {} - * test: - * type: object - * description: The $or's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $or's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $or's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $or's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $or's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $or's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * properties: {} - * test: - * type: object - * description: The $eq's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $eq's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $eq's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $eq's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $eq's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $eq's @matchall@2360. - * properties: {} - * - type: array - * description: The deleted at's $eq. - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $eq's exec. - * properties: {} - * test: - * type: object - * description: The $eq's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $eq's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $eq's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $eq's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $eq's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $eq's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $ne's exec. - * properties: {} - * test: - * type: object - * description: The $ne's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $ne's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $ne's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $ne's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $ne's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $ne's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $in's exec. - * properties: {} - * test: - * type: object - * description: The $in's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $in's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $in's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $in's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $in's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $in's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $nin's exec. - * properties: {} - * test: - * type: object - * description: The $nin's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $nin's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $nin's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $nin's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $nin's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $nin's @matchall@2360. - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The deleted at's $not. - * - type: object - * description: The deleted at's $not. - * x-schemaName: RegExp - * required: - * - exec - * - test - * - source - * - global - * - ignoreCase - * - multiline - * - lastIndex - * - flags - * - sticky - * - unicode - * - dotAll - * - __@match@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $not's exec. - * properties: {} - * test: - * type: object - * description: The $not's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $not's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $not's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $not's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $not's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $not's @matchall@2360. - * properties: {} - * - type: object - * description: The deleted at's $not. - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The $not's $eq. - * - type: object - * description: The $not's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The $not's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The $not's $ne. - * - type: object - * description: The $not's $ne. - * x-schemaName: RegExp - * properties: {} - * $in: - * type: array - * description: The $not's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * properties: {} - * $nin: - * type: array - * description: The $not's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The $not's details. - * properties: {} - * - type: array - * description: The $not's details. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The $not's $gt. - * - type: object - * description: The $not's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The $not's $gte. - * - type: object - * description: The $not's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The $not's $lt. - * - type: object - * description: The $not's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The $not's $lte. - * - type: object - * description: The $not's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The $not's $like. - * $re: - * type: string - * title: $re - * description: The $not's $re. - * $ilike: - * type: string - * title: $ilike - * description: The $not's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The $not's $fulltext. - * $overlap: - * type: array - * description: The $not's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The $not's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The $not's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The $not's $exists. - * - type: array - * description: The deleted at's $not. - * 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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $not's exec. - * properties: {} - * test: - * type: object - * description: The $not's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $not's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $not's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $not's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $not's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $not's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $gt's exec. - * properties: {} - * test: - * type: object - * description: The $gt's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $gt's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $gt's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $gt's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $gt's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $gt's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $gte's exec. - * properties: {} - * test: - * type: object - * description: The $gte's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $gte's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $gte's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $gte's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $gte's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $gte's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $lt's exec. - * properties: {} - * test: - * type: object - * description: The $lt's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $lt's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $lt's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $lt's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $lt's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $lt's @matchall@2360. - * properties: {} - * $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@2351 - * - __@replace@2353 - * - __@search@2356 - * - __@matchAll@2360 - * properties: - * exec: - * type: object - * description: The $lte's exec. - * properties: {} - * test: - * type: object - * description: The $lte's test. - * properties: {} - * 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. - * properties: {} - * 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@2351: - * type: object - * description: The $lte's @match@2351. - * properties: {} - * __@replace@2353: - * type: object - * description: The $lte's @replace@2353. - * properties: {} - * __@search@2356: - * type: object - * description: The $lte's @search@2356. - * properties: {} - * __@split@2358: - * type: object - * description: The $lte's @split@2358. - * properties: {} - * __@matchAll@2360: - * type: object - * description: The $lte's @matchall@2360. - * properties: {} - * $like: - * type: string - * title: $like - * description: The deleted at's $like. - * $re: - * type: string - * title: $re - * description: The deleted at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The deleted at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The deleted at's $fulltext. - * $overlap: - * type: array - * description: The deleted at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The deleted at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The deleted at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The deleted at's $exists. - * $and: - * type: array - * description: The product's $and. - * items: - * type: object - * description: The $and's details. - * x-schemaName: AdminGetProductsParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * status: - * type: array - * description: The $and's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * title: - * type: string - * title: title - * description: The $and's title. - * handle: - * type: string - * title: handle - * description: The $and's handle. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $and's is giftcard. - * price_list_id: - * type: array - * description: The $and's price list id. - * items: - * type: string - * title: price_list_id - * description: The price list id's details. - * sales_channel_id: - * type: array - * description: The $and's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * collection_id: - * type: array - * description: The $and's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * tags: - * type: array - * description: The $and's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. - * type_id: - * type: array - * description: The $and's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * variants: - * type: object - * description: The $and's variants. - * properties: {} - * created_at: - * type: object - * description: The $and's created at. - * properties: - * $and: - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The created at's $eq. - * - type: object - * description: The created at's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The created at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The created at's $ne. - * - type: object - * description: The created at's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The created at's $not. - * - type: object - * description: The created at's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The created at's $not. - * properties: {} - * - type: array - * description: The created at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The created at's $gt. - * - type: object - * description: The created at's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The created at's $gte. - * - type: object - * description: The created at's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The created at's $lt. - * - type: object - * description: The created at's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The created at's $lte. - * - type: object - * description: The created at's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The created at's $like. - * $re: - * type: string - * title: $re - * description: The created at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The created at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The created at's $fulltext. - * $overlap: - * type: array - * description: The created at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The created at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The created at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The created at's $exists. - * updated_at: - * type: object - * description: The $and's updated at. - * properties: - * $and: - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The updated at's $eq. - * - type: object - * description: The updated at's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The updated at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The updated at's $ne. - * - type: object - * description: The updated at's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The updated at's $not. - * - type: object - * description: The updated at's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The updated at's $not. - * properties: {} - * - type: array - * description: The updated at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The updated at's $gt. - * - type: object - * description: The updated at's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The updated at's $gte. - * - type: object - * description: The updated at's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The updated at's $lt. - * - type: object - * description: The updated at's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The updated at's $lte. - * - type: object - * description: The updated at's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The updated at's $like. - * $re: - * type: string - * title: $re - * description: The updated at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The updated at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The updated at's $fulltext. - * $overlap: - * type: array - * description: The updated at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The updated at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The updated at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The updated at's $exists. - * deleted_at: - * type: object - * description: The $and's deleted at. - * properties: - * $and: - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The deleted at's $eq. - * - type: object - * description: The deleted at's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The deleted at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The deleted at's $ne. - * - type: object - * description: The deleted at's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The deleted at's $not. - * - type: object - * description: The deleted at's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The deleted at's $not. - * properties: {} - * - type: array - * description: The deleted at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The deleted at's $gt. - * - type: object - * description: The deleted at's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The deleted at's $gte. - * - type: object - * description: The deleted at's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The deleted at's $lt. - * - type: object - * description: The deleted at's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The deleted at's $lte. - * - type: object - * description: The deleted at's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The deleted at's $like. - * $re: - * type: string - * title: $re - * description: The deleted at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The deleted at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The deleted at's $fulltext. - * $overlap: - * type: array - * description: The deleted at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The deleted at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The deleted at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The deleted at's $exists. - * $and: - * type: array - * description: The $and's details. - * items: - * type: object - * description: The $and's details. - * x-schemaName: AdminGetProductsParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * status: - * type: array - * description: The $and's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * title: - * type: string - * title: title - * description: The $and's title. - * handle: - * type: string - * title: handle - * description: The $and's handle. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $and's is giftcard. - * price_list_id: - * type: array - * description: The $and's price list id. - * items: - * type: string - * title: price_list_id - * description: The price list id's details. - * sales_channel_id: - * type: array - * description: The $and's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * collection_id: - * type: array - * description: The $and's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * tags: - * type: array - * description: The $and's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. - * type_id: - * type: array - * description: The $and's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * variants: - * type: object - * description: The $and's variants. - * properties: {} - * created_at: - * type: object - * description: The $and's created at. - * properties: {} - * updated_at: - * type: object - * description: The $and's updated at. - * properties: {} - * deleted_at: - * type: object - * description: The $and's deleted at. - * properties: {} - * $and: - * type: array - * description: The $and's details. - * items: - * type: object - * description: The $and's details. - * x-schemaName: AdminGetProductsParams - * properties: {} - * $or: - * type: array - * description: The $and's $or. - * items: - * type: object - * description: The $or's details. - * x-schemaName: AdminGetProductsParams - * properties: {} - * expand: - * type: string - * title: expand - * description: The $and's expand. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * order: - * type: string - * title: order - * description: The $and's order. - * $or: - * type: array - * description: The $and's $or. - * items: - * type: object - * description: The $or's details. - * x-schemaName: AdminGetProductsParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * status: - * type: array - * description: The $or's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * title: - * type: string - * title: title - * description: The $or's title. - * handle: - * type: string - * title: handle - * description: The $or's handle. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $or's is giftcard. - * price_list_id: - * type: array - * description: The $or's price list id. - * items: - * type: string - * title: price_list_id - * description: The price list id's details. - * sales_channel_id: - * type: array - * description: The $or's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * collection_id: - * type: array - * description: The $or's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * tags: - * type: array - * description: The $or's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. - * type_id: - * type: array - * description: The $or's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * variants: - * type: object - * description: The $or's variants. - * properties: {} - * created_at: - * type: object - * description: The $or's created at. - * properties: {} - * updated_at: - * type: object - * description: The $or's updated at. - * properties: {} - * deleted_at: - * type: object - * description: The $or's deleted at. - * properties: {} - * $and: - * type: array - * description: The $or's $and. - * items: - * type: object - * description: The $and's details. - * x-schemaName: AdminGetProductsParams - * properties: {} - * $or: - * type: array - * description: The $or's details. - * items: - * type: object - * description: The $or's details. - * x-schemaName: AdminGetProductsParams - * properties: {} - * expand: - * type: string - * title: expand - * description: The $or's expand. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * order: - * type: string - * title: order - * description: The $or's order. - * expand: - * type: string - * title: expand - * description: The $and's expand. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * order: - * type: string - * title: order - * description: The $and's order. - * $or: - * type: array - * description: The product's $or. - * items: - * type: object - * description: The $or's details. - * x-schemaName: AdminGetProductsParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * status: - * type: array - * description: The $or's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * title: - * type: string - * title: title - * description: The $or's title. - * handle: - * type: string - * title: handle - * description: The $or's handle. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $or's is giftcard. - * price_list_id: - * type: array - * description: The $or's price list id. - * items: - * type: string - * title: price_list_id - * description: The price list id's details. - * sales_channel_id: - * type: array - * description: The $or's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * collection_id: - * type: array - * description: The $or's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * tags: - * type: array - * description: The $or's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. - * type_id: - * type: array - * description: The $or's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * variants: - * type: object - * description: The $or's variants. - * properties: {} - * created_at: - * type: object - * description: The $or's created at. - * properties: - * $and: - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The created at's $eq. - * - type: object - * description: The created at's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The created at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The created at's $ne. - * - type: object - * description: The created at's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The created at's $not. - * - type: object - * description: The created at's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The created at's $not. - * properties: {} - * - type: array - * description: The created at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The created at's $gt. - * - type: object - * description: The created at's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The created at's $gte. - * - type: object - * description: The created at's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The created at's $lt. - * - type: object - * description: The created at's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The created at's $lte. - * - type: object - * description: The created at's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The created at's $like. - * $re: - * type: string - * title: $re - * description: The created at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The created at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The created at's $fulltext. - * $overlap: - * type: array - * description: The created at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The created at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The created at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The created at's $exists. - * updated_at: - * type: object - * description: The $or's updated at. - * properties: - * $and: - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The updated at's $eq. - * - type: object - * description: The updated at's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The updated at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The updated at's $ne. - * - type: object - * description: The updated at's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The updated at's $not. - * - type: object - * description: The updated at's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The updated at's $not. - * properties: {} - * - type: array - * description: The updated at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The updated at's $gt. - * - type: object - * description: The updated at's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The updated at's $gte. - * - type: object - * description: The updated at's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The updated at's $lt. - * - type: object - * description: The updated at's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The updated at's $lte. - * - type: object - * description: The updated at's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The updated at's $like. - * $re: - * type: string - * title: $re - * description: The updated at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The updated at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The updated at's $fulltext. - * $overlap: - * type: array - * description: The updated at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The updated at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The updated at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The updated at's $exists. - * deleted_at: - * type: object - * description: The $or's deleted at. - * properties: - * $and: - * 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 - * properties: {} - * - type: object - * description: The $and's details. - * properties: {} - * - 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 - * properties: {} - * $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 - * properties: {} - * - type: object - * description: The $or's details. - * properties: {} - * - 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 - * properties: {} - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The deleted at's $eq. - * - type: object - * description: The deleted at's $eq. - * x-schemaName: RegExp - * properties: {} - * - type: array - * description: The deleted at's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * properties: {} - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The deleted at's $ne. - * - type: object - * description: The deleted at's $ne. - * x-schemaName: RegExp - * properties: {} - * $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 - * properties: {} - * $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 - * properties: {} - * $not: - * oneOf: - * - type: string - * title: $not - * description: The deleted at's $not. - * - type: object - * description: The deleted at's $not. - * x-schemaName: RegExp - * properties: {} - * - type: object - * description: The deleted at's $not. - * properties: {} - * - type: array - * description: The deleted at's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * properties: {} - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The deleted at's $gt. - * - type: object - * description: The deleted at's $gt. - * x-schemaName: RegExp - * properties: {} - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The deleted at's $gte. - * - type: object - * description: The deleted at's $gte. - * x-schemaName: RegExp - * properties: {} - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The deleted at's $lt. - * - type: object - * description: The deleted at's $lt. - * x-schemaName: RegExp - * properties: {} - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The deleted at's $lte. - * - type: object - * description: The deleted at's $lte. - * x-schemaName: RegExp - * properties: {} - * $like: - * type: string - * title: $like - * description: The deleted at's $like. - * $re: - * type: string - * title: $re - * description: The deleted at's $re. - * $ilike: - * type: string - * title: $ilike - * description: The deleted at's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The deleted at's $fulltext. - * $overlap: - * type: array - * description: The deleted at's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The deleted at's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The deleted at's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The deleted at's $exists. - * $and: - * type: array - * description: The $or's $and. - * items: - * type: object - * description: The $and's details. - * x-schemaName: AdminGetProductsParams - * properties: - * q: - * type: string - * title: q - * description: The $and's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $and's ID. - * - type: array - * description: The $and's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * status: - * type: array - * description: The $and's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * title: - * type: string - * title: title - * description: The $and's title. - * handle: - * type: string - * title: handle - * description: The $and's handle. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $and's is giftcard. - * price_list_id: - * type: array - * description: The $and's price list id. - * items: - * type: string - * title: price_list_id - * description: The price list id's details. - * sales_channel_id: - * type: array - * description: The $and's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * collection_id: - * type: array - * description: The $and's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * tags: - * type: array - * description: The $and's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. - * type_id: - * type: array - * description: The $and's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * variants: - * type: object - * description: The $and's variants. - * properties: {} - * created_at: - * type: object - * description: The $and's created at. - * properties: {} - * updated_at: - * type: object - * description: The $and's updated at. - * properties: {} - * deleted_at: - * type: object - * description: The $and's deleted at. - * properties: {} - * $and: - * type: array - * description: The $and's details. - * items: - * type: object - * description: The $and's details. - * x-schemaName: AdminGetProductsParams - * properties: {} - * $or: - * type: array - * description: The $and's $or. - * items: - * type: object - * description: The $or's details. - * x-schemaName: AdminGetProductsParams - * properties: {} - * expand: - * type: string - * title: expand - * description: The $and's expand. - * fields: - * type: string - * title: fields - * description: The $and's fields. - * offset: - * type: number - * title: offset - * description: The $and's offset. - * limit: - * type: number - * title: limit - * description: The $and's limit. - * order: - * type: string - * title: order - * description: The $and's order. - * $or: - * type: array - * description: The $or's details. - * items: - * type: object - * description: The $or's details. - * x-schemaName: AdminGetProductsParams - * properties: - * q: - * type: string - * title: q - * description: The $or's q. - * id: - * oneOf: - * - type: string - * title: id - * description: The $or's ID. - * - type: array - * description: The $or's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * status: - * type: array - * description: The $or's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * title: - * type: string - * title: title - * description: The $or's title. - * handle: - * type: string - * title: handle - * description: The $or's handle. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The $or's is giftcard. - * price_list_id: - * type: array - * description: The $or's price list id. - * items: - * type: string - * title: price_list_id - * description: The price list id's details. - * sales_channel_id: - * type: array - * description: The $or's sales channel id. - * items: - * type: string - * title: sales_channel_id - * description: The sales channel id's details. - * collection_id: - * type: array - * description: The $or's collection id. - * items: - * type: string - * title: collection_id - * description: The collection id's details. - * tags: - * type: array - * description: The $or's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. - * type_id: - * type: array - * description: The $or's type id. - * items: - * type: string - * title: type_id - * description: The type id's details. - * variants: - * type: object - * description: The $or's variants. - * properties: {} - * created_at: - * type: object - * description: The $or's created at. - * properties: {} - * updated_at: - * type: object - * description: The $or's updated at. - * properties: {} - * deleted_at: - * type: object - * description: The $or's deleted at. - * properties: {} - * $and: - * type: array - * description: The $or's $and. - * items: - * type: object - * description: The $and's details. - * x-schemaName: AdminGetProductsParams - * properties: {} - * $or: - * type: array - * description: The $or's details. - * items: - * type: object - * description: The $or's details. - * x-schemaName: AdminGetProductsParams - * properties: {} - * expand: - * type: string - * title: expand - * description: The $or's expand. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * order: - * type: string - * title: order - * description: The $or's order. - * expand: - * type: string - * title: expand - * description: The $or's expand. - * fields: - * type: string - * title: fields - * description: The $or's fields. - * offset: - * type: number - * title: offset - * description: The $or's offset. - * limit: - * type: number - * title: limit - * description: The $or's limit. - * order: - * type: string - * title: order - * description: The $or's order. - * expand: - * type: string - * title: expand - * description: The product's expand. - * fields: - * type: string - * title: fields - * description: The product's fields. - * offset: - * type: number - * title: offset - * description: The product's offset. - * limit: - * type: number - * title: limit - * description: The product's limit. - * order: - * type: string - * title: order - * description: The product's order. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminGetPromotionsParams.ts b/docs-util/oas-output/schemas/AdminGetPromotionsParams.ts deleted file mode 100644 index 58ade2204e..0000000000 --- a/docs-util/oas-output/schemas/AdminGetPromotionsParams.ts +++ /dev/null @@ -1,33 +0,0 @@ -/** - * @schema AdminGetPromotionsParams - * type: object - * description: SUMMARY - * x-schemaName: AdminGetPromotionsParams - * properties: - * code: - * type: string - * title: code - * description: The promotion's code. - * expand: - * type: string - * title: expand - * description: The promotion's expand. - * fields: - * type: string - * title: fields - * description: The promotion's fields. - * offset: - * type: number - * title: offset - * description: The promotion's offset. - * limit: - * type: number - * title: limit - * description: The promotion's limit. - * order: - * type: string - * title: order - * description: The promotion's order. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.ts b/docs-util/oas-output/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.ts deleted file mode 100644 index 6a2c6c5107..0000000000 --- a/docs-util/oas-output/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.ts +++ /dev/null @@ -1,25 +0,0 @@ -/** - * @schema AdminPostCustomerGroupsGroupCustomersBatchReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq - * required: - * - customer_ids - * properties: - * customer_ids: - * type: array - * description: The customer group's customer ids. - * items: - * type: object - * description: The customer id's customer ids. - * x-schemaName: CustomerGroupsBatchCustomer - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The customer id's ID. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.ts b/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.ts deleted file mode 100644 index ca72ad1900..0000000000 --- a/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.ts +++ /dev/null @@ -1,49 +0,0 @@ -/** - * @schema AdminPostFulfillmentShippingOptionsRulesBatchAddReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq - * required: - * - rules - * properties: - * rules: - * type: array - * description: The fulfillment's rules. - * items: - * type: object - * description: The rule's rules. - * x-schemaName: FulfillmentRuleCreate - * required: - * - operator - * - attribute - * - value - * properties: - * operator: - * type: string - * enum: - * - in - * - eq - * - ne - * - gt - * - gte - * - lt - * - lte - * - nin - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * value: - * oneOf: - * - type: string - * title: value - * description: The rule's value. - * - type: array - * description: The rule's value. - * items: - * type: string - * title: value - * description: The value's details. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.ts b/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.ts deleted file mode 100644 index 479af57502..0000000000 --- a/docs-util/oas-output/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.ts +++ /dev/null @@ -1,18 +0,0 @@ -/** - * @schema AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq - * required: - * - rule_ids - * properties: - * rule_ids: - * type: array - * description: The fulfillment's rule ids. - * items: - * type: string - * title: rule_ids - * description: The rule id's rule ids. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostInventoryItemsInventoryItemReq.ts b/docs-util/oas-output/schemas/AdminPostInventoryItemsInventoryItemReq.ts deleted file mode 100644 index d1f3b83dc5..0000000000 --- a/docs-util/oas-output/schemas/AdminPostInventoryItemsInventoryItemReq.ts +++ /dev/null @@ -1,61 +0,0 @@ -/** - * @schema AdminPostInventoryItemsInventoryItemReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostInventoryItemsInventoryItemReq - * properties: - * sku: - * type: string - * title: sku - * description: The inventory item's sku. - * origin_country: - * type: string - * title: origin_country - * description: The inventory item's origin country. - * hs_code: - * type: string - * title: hs_code - * description: The inventory item's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The inventory item's mid code. - * material: - * type: string - * title: material - * description: The inventory item's material. - * weight: - * type: number - * title: weight - * description: The inventory item's weight. - * height: - * type: number - * title: height - * description: The inventory item's height. - * length: - * type: number - * title: length - * description: The inventory item's length. - * width: - * type: number - * title: width - * description: The inventory item's width. - * title: - * type: string - * title: title - * description: The inventory item's title. - * description: - * type: string - * title: description - * description: The inventory item's description. - * thumbnail: - * type: string - * title: thumbnail - * description: The inventory item's thumbnail. - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: The inventory item's requires shipping. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.ts b/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.ts deleted file mode 100644 index 6cdab7f4e2..0000000000 --- a/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * @schema AdminPostInventoryItemsItemLocationLevelsLevelReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostInventoryItemsItemLocationLevelsLevelReq - * properties: - * incoming_quantity: - * type: number - * title: incoming_quantity - * description: The inventory item's incoming quantity. - * stocked_quantity: - * type: number - * title: stocked_quantity - * description: The inventory item's stocked quantity. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsReq.ts b/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsReq.ts deleted file mode 100644 index 9664db8855..0000000000 --- a/docs-util/oas-output/schemas/AdminPostInventoryItemsItemLocationLevelsReq.ts +++ /dev/null @@ -1,24 +0,0 @@ -/** - * @schema AdminPostInventoryItemsItemLocationLevelsReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq - * required: - * - location_id - * - stocked_quantity - * properties: - * location_id: - * type: string - * title: location_id - * description: The inventory item's location id. - * stocked_quantity: - * type: number - * title: stocked_quantity - * description: The inventory item's stocked quantity. - * incoming_quantity: - * type: number - * title: incoming_quantity - * description: The inventory item's incoming quantity. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostInventoryItemsReq.ts b/docs-util/oas-output/schemas/AdminPostInventoryItemsReq.ts deleted file mode 100644 index ce37692937..0000000000 --- a/docs-util/oas-output/schemas/AdminPostInventoryItemsReq.ts +++ /dev/null @@ -1,61 +0,0 @@ -/** - * @schema AdminPostInventoryItemsReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostInventoryItemsReq - * properties: - * sku: - * type: string - * title: sku - * description: The inventory item's sku. - * hs_code: - * type: string - * title: hs_code - * description: The inventory item's hs code. - * weight: - * type: number - * title: weight - * description: The inventory item's weight. - * length: - * type: number - * title: length - * description: The inventory item's length. - * height: - * type: number - * title: height - * description: The inventory item's height. - * width: - * type: number - * title: width - * description: The inventory item's width. - * origin_country: - * type: string - * title: origin_country - * description: The inventory item's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The inventory item's mid code. - * material: - * type: string - * title: material - * description: The inventory item's material. - * title: - * type: string - * title: title - * description: The inventory item's title. - * description: - * type: string - * title: description - * description: The inventory item's description. - * thumbnail: - * type: string - * title: thumbnail - * description: The inventory item's thumbnail. - * metadata: - * type: object - * description: The inventory item's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostInvitesInviteAcceptReq.ts b/docs-util/oas-output/schemas/AdminPostInvitesInviteAcceptReq.ts deleted file mode 100644 index 9387513090..0000000000 --- a/docs-util/oas-output/schemas/AdminPostInvitesInviteAcceptReq.ts +++ /dev/null @@ -1,20 +0,0 @@ -/** - * @schema AdminPostInvitesInviteAcceptReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostInvitesInviteAcceptReq - * required: - * - first_name - * - last_name - * properties: - * first_name: - * type: string - * title: first_name - * description: The invite's first name. - * last_name: - * type: string - * title: last_name - * description: The invite's last name. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPaymentsCapturesReq.ts b/docs-util/oas-output/schemas/AdminPostPaymentsCapturesReq.ts deleted file mode 100644 index f1e704fd60..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPaymentsCapturesReq.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema AdminPostPaymentsCapturesReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPaymentsCapturesReq - * properties: - * amount: - * type: number - * title: amount - * description: The payment's amount. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPaymentsRefundsReq.ts b/docs-util/oas-output/schemas/AdminPostPaymentsRefundsReq.ts deleted file mode 100644 index 8e19d73f50..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPaymentsRefundsReq.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema AdminPostPaymentsRefundsReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPaymentsRefundsReq - * properties: - * amount: - * type: number - * title: amount - * description: The payment's amount. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.ts b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.ts deleted file mode 100644 index 1fc8a41f09..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.ts +++ /dev/null @@ -1,47 +0,0 @@ -/** - * @schema AdminPostPriceListsPriceListPricesBatchAddReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq - * required: - * - prices - * properties: - * prices: - * type: array - * description: The price list's prices. - * items: - * type: object - * description: The price's prices. - * x-schemaName: AdminPriceListPricesCreateReq - * required: - * - currency_code - * - amount - * - variant_id - * properties: - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * variant_id: - * type: string - * title: variant_id - * description: The price's variant id. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * rules: - * type: object - * description: The price's rules. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.ts b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.ts deleted file mode 100644 index fc96d81635..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.ts +++ /dev/null @@ -1,18 +0,0 @@ -/** - * @schema AdminPostPriceListsPriceListPricesBatchRemoveReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq - * required: - * - ids - * properties: - * ids: - * type: array - * description: The price list's ids. - * items: - * type: string - * title: ids - * description: The id's ids. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListReq.ts b/docs-util/oas-output/schemas/AdminPostPriceListsPriceListReq.ts deleted file mode 100644 index cd5e738a81..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPriceListsPriceListReq.ts +++ /dev/null @@ -1,77 +0,0 @@ -/** - * @schema AdminPostPriceListsPriceListReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPriceListsPriceListReq - * required: - * - prices - * properties: - * title: - * type: string - * title: title - * description: The price list's title. - * description: - * type: string - * title: description - * description: The price list's description. - * starts_at: - * type: string - * title: starts_at - * description: The price list's starts at. - * ends_at: - * type: string - * title: ends_at - * description: The price list's ends at. - * status: - * type: string - * enum: - * - active - * - draft - * type: - * type: string - * enum: - * - sale - * - override - * prices: - * type: array - * description: The price list's prices. - * items: - * type: object - * description: The price's prices. - * x-schemaName: AdminPriceListPricesCreateReq - * required: - * - currency_code - * - amount - * - variant_id - * properties: - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * variant_id: - * type: string - * title: variant_id - * description: The price's variant id. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * rules: - * type: object - * description: The price's rules. - * properties: {} - * rules: - * type: object - * description: The price list's rules. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPriceListsReq.ts b/docs-util/oas-output/schemas/AdminPostPriceListsReq.ts deleted file mode 100644 index cd4c74367d..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPriceListsReq.ts +++ /dev/null @@ -1,80 +0,0 @@ -/** - * @schema AdminPostPriceListsReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPriceListsReq - * required: - * - title - * - description - * - type - * - prices - * properties: - * title: - * type: string - * title: title - * description: The price list's title. - * description: - * type: string - * title: description - * description: The price list's description. - * starts_at: - * type: string - * title: starts_at - * description: The price list's starts at. - * ends_at: - * type: string - * title: ends_at - * description: The price list's ends at. - * status: - * type: string - * enum: - * - active - * - draft - * type: - * type: string - * enum: - * - sale - * - override - * prices: - * type: array - * description: The price list's prices. - * items: - * type: object - * description: The price's prices. - * x-schemaName: AdminPriceListPricesCreateReq - * required: - * - currency_code - * - amount - * - variant_id - * properties: - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * variant_id: - * type: string - * title: variant_id - * description: The price's variant id. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * rules: - * type: object - * description: The price's rules. - * properties: {} - * rules: - * type: object - * description: The price list's rules. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPricingRuleTypesReq.ts b/docs-util/oas-output/schemas/AdminPostPricingRuleTypesReq.ts deleted file mode 100644 index dcda3979a0..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPricingRuleTypesReq.ts +++ /dev/null @@ -1,25 +0,0 @@ -/** - * @schema AdminPostPricingRuleTypesReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPricingRuleTypesReq - * required: - * - name - * - rule_attribute - * - default_priority - * properties: - * name: - * type: string - * title: name - * description: The pricing's name. - * rule_attribute: - * type: string - * title: rule_attribute - * description: The pricing's rule attribute. - * default_priority: - * type: number - * title: default_priority - * description: The pricing's default priority. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPricingRuleTypesRuleTypeReq.ts b/docs-util/oas-output/schemas/AdminPostPricingRuleTypesRuleTypeReq.ts deleted file mode 100644 index c3c41f6311..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPricingRuleTypesRuleTypeReq.ts +++ /dev/null @@ -1,21 +0,0 @@ -/** - * @schema AdminPostPricingRuleTypesRuleTypeReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPricingRuleTypesRuleTypeReq - * properties: - * name: - * type: string - * title: name - * description: The pricing's name. - * rule_attribute: - * type: string - * title: rule_attribute - * description: The pricing's rule attribute. - * default_priority: - * type: number - * title: default_priority - * description: The pricing's default priority. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionReq.ts b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionReq.ts deleted file mode 100644 index a21c3f6d85..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionReq.ts +++ /dev/null @@ -1,67 +0,0 @@ -/** - * @schema AdminPostPromotionsPromotionReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPromotionsPromotionReq - * properties: - * code: - * type: string - * title: code - * description: The promotion's code. - * is_automatic: - * type: boolean - * title: is_automatic - * description: The promotion's is automatic. - * type: - * type: string - * enum: - * - standard - * - buyget - * campaign_id: - * type: string - * title: campaign_id - * description: The promotion's campaign id. - * campaign: - * $ref: "#/components/schemas/AdminPostCampaignsReq" - * application_method: - * $ref: "#/components/schemas/ApplicationMethodsMethodPostReq" - * rules: - * type: array - * description: The promotion's rules. - * items: - * type: object - * description: The rule's rules. - * x-schemaName: PromotionRule - * required: - * - operator - * - attribute - * - values - * properties: - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * values: - * type: array - * description: The rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.ts b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.ts deleted file mode 100644 index 00943a11cb..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.ts +++ /dev/null @@ -1,48 +0,0 @@ -/** - * @schema AdminPostPromotionsPromotionRulesBatchAddReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq - * required: - * - rules - * properties: - * rules: - * type: array - * description: The promotion's rules. - * items: - * type: object - * description: The rule's rules. - * x-schemaName: PromotionRule - * required: - * - operator - * - attribute - * - values - * properties: - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * values: - * type: array - * description: The rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.ts b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.ts deleted file mode 100644 index 4543fcc384..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.ts +++ /dev/null @@ -1,18 +0,0 @@ -/** - * @schema AdminPostPromotionsPromotionRulesBatchRemoveReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq - * required: - * - rule_ids - * properties: - * rule_ids: - * type: array - * description: The promotion's rule ids. - * items: - * type: string - * title: rule_ids - * description: The rule id's rule ids. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.ts b/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.ts deleted file mode 100644 index 359ec8a694..0000000000 --- a/docs-util/oas-output/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.ts +++ /dev/null @@ -1,52 +0,0 @@ -/** - * @schema AdminPostPromotionsPromotionRulesBatchUpdateReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq - * required: - * - rules - * properties: - * rules: - * type: array - * description: The promotion's rules. - * items: - * type: object - * description: The rule's rules. - * x-schemaName: UpdatePromotionRule - * required: - * - id - * - attribute - * - values - * properties: - * id: - * type: string - * title: id - * description: The rule's ID. - * operator: - * type: string - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * values: - * type: array - * description: The rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostStockLocationsReq.ts b/docs-util/oas-output/schemas/AdminPostStockLocationsReq.ts deleted file mode 100644 index 5ffb738d90..0000000000 --- a/docs-util/oas-output/schemas/AdminPostStockLocationsReq.ts +++ /dev/null @@ -1,25 +0,0 @@ -/** - * @schema AdminPostStockLocationsReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostStockLocationsReq - * required: - * - name - * properties: - * name: - * type: string - * title: name - * description: The stock location's name. - * address: - * $ref: "#/components/schemas/StockLocationAddress" - * address_id: - * type: string - * title: address_id - * description: The stock location's address id. - * metadata: - * type: object - * description: The stock location's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostTaxRatesReq.ts b/docs-util/oas-output/schemas/AdminPostTaxRatesReq.ts deleted file mode 100644 index 342cc5b9fb..0000000000 --- a/docs-util/oas-output/schemas/AdminPostTaxRatesReq.ts +++ /dev/null @@ -1,59 +0,0 @@ -/** - * @schema AdminPostTaxRatesReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostTaxRatesReq - * required: - * - name - * - tax_region_id - * properties: - * rate: - * type: number - * title: rate - * description: The tax rate's rate. - * code: - * type: string - * title: code - * description: The tax rate's code. - * rules: - * type: array - * description: The tax rate's rules. - * items: - * type: object - * description: The rule's rules. - * x-schemaName: CreateTaxRateRule - * required: - * - reference - * - reference_id - * properties: - * reference: - * type: string - * title: reference - * description: The rule's reference. - * reference_id: - * type: string - * title: reference_id - * description: The rule's reference id. - * name: - * type: string - * title: name - * description: The tax rate's name. - * is_default: - * type: boolean - * title: is_default - * description: The tax rate's is default. - * is_combinable: - * type: boolean - * title: is_combinable - * description: The tax rate's is combinable. - * tax_region_id: - * type: string - * title: tax_region_id - * description: The tax rate's tax region id. - * metadata: - * type: object - * description: The tax rate's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateReq.ts b/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateReq.ts deleted file mode 100644 index cc254ee496..0000000000 --- a/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateReq.ts +++ /dev/null @@ -1,46 +0,0 @@ -/** - * @schema AdminPostTaxRatesTaxRateReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostTaxRatesTaxRateReq - * properties: - * code: - * type: string - * title: code - * description: The tax rate's code. - * name: - * type: string - * title: name - * description: The tax rate's name. - * region_id: - * type: string - * title: region_id - * description: The tax rate's region id. - * rate: - * type: number - * title: rate - * description: The tax rate's rate. - * products: - * type: array - * description: The tax rate's products. - * items: - * type: string - * title: products - * description: The product's products. - * shipping_options: - * type: array - * description: The tax rate's shipping options. - * items: - * type: string - * title: shipping_options - * description: The shipping option's shipping options. - * product_types: - * type: array - * description: The tax rate's product types. - * items: - * type: string - * title: product_types - * description: The product type's product types. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateRulesReq.ts b/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateRulesReq.ts deleted file mode 100644 index 0664aa311a..0000000000 --- a/docs-util/oas-output/schemas/AdminPostTaxRatesTaxRateRulesReq.ts +++ /dev/null @@ -1,20 +0,0 @@ -/** - * @schema AdminPostTaxRatesTaxRateRulesReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostTaxRatesTaxRateRulesReq - * required: - * - reference - * - reference_id - * properties: - * reference: - * type: string - * title: reference - * description: The tax rate's reference. - * reference_id: - * type: string - * title: reference_id - * description: The tax rate's reference id. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostTaxRegionsReq.ts b/docs-util/oas-output/schemas/AdminPostTaxRegionsReq.ts deleted file mode 100644 index b00a1ceebb..0000000000 --- a/docs-util/oas-output/schemas/AdminPostTaxRegionsReq.ts +++ /dev/null @@ -1,29 +0,0 @@ -/** - * @schema AdminPostTaxRegionsReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostTaxRegionsReq - * required: - * - country_code - * properties: - * country_code: - * type: string - * title: country_code - * description: The tax region's country code. - * province_code: - * type: string - * title: province_code - * description: The tax region's province code. - * parent_id: - * type: string - * title: parent_id - * description: The tax region's parent id. - * default_tax_rate: - * $ref: "#/components/schemas/CreateDefaultTaxRate" - * metadata: - * type: object - * description: The tax region's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostWorkflowsAsyncResponseReq.ts b/docs-util/oas-output/schemas/AdminPostWorkflowsAsyncResponseReq.ts deleted file mode 100644 index 4ca8ed14c1..0000000000 --- a/docs-util/oas-output/schemas/AdminPostWorkflowsAsyncResponseReq.ts +++ /dev/null @@ -1,27 +0,0 @@ -/** - * @schema AdminPostWorkflowsAsyncResponseReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostWorkflowsAsyncResponseReq - * required: - * - transaction_id - * - step_id - * properties: - * transaction_id: - * type: string - * title: transaction_id - * description: The workflows execution's transaction id. - * step_id: - * type: string - * title: step_id - * description: The workflows execution's step id. - * response: {} - * compensate_input: {} - * action: - * type: string - * enum: - * - invoke - * - compensate - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminPostWorkflowsRunReq.ts b/docs-util/oas-output/schemas/AdminPostWorkflowsRunReq.ts deleted file mode 100644 index ff8ee01d5a..0000000000 --- a/docs-util/oas-output/schemas/AdminPostWorkflowsRunReq.ts +++ /dev/null @@ -1,14 +0,0 @@ -/** - * @schema AdminPostWorkflowsRunReq - * type: object - * description: SUMMARY - * x-schemaName: AdminPostWorkflowsRunReq - * properties: - * input: {} - * transaction_id: - * type: string - * title: transaction_id - * description: The workflows execution's transaction id. - * -*/ - diff --git a/docs-util/oas-output/schemas/AdminUpdateUserRequest.ts b/docs-util/oas-output/schemas/AdminUpdateUserRequest.ts deleted file mode 100644 index 9799b8c543..0000000000 --- a/docs-util/oas-output/schemas/AdminUpdateUserRequest.ts +++ /dev/null @@ -1,23 +0,0 @@ -/** - * @schema AdminUpdateUserRequest - * type: object - * description: SUMMARY - * x-schemaName: AdminUpdateUserRequest - * required: - * - avatar_url - * properties: - * first_name: - * type: string - * title: first_name - * description: The user's first name. - * last_name: - * type: string - * title: last_name - * description: The user's last name. - * avatar_url: - * type: string - * title: avatar_url - * description: The user's avatar url. - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateApiKey.ts b/docs-util/oas-output/schemas/CreateApiKey.ts deleted file mode 100644 index b21a19571c..0000000000 --- a/docs-util/oas-output/schemas/CreateApiKey.ts +++ /dev/null @@ -1,21 +0,0 @@ -/** - * @schema CreateApiKey - * type: object - * description: SUMMARY - * x-schemaName: CreateApiKey - * required: - * - title - * - type - * properties: - * title: - * type: string - * title: title - * description: The api key's title. - * type: - * type: string - * enum: - * - secret - * - publishable - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateCartWorkflowInput.ts b/docs-util/oas-output/schemas/CreateCartWorkflowInput.ts deleted file mode 100644 index f43c32c367..0000000000 --- a/docs-util/oas-output/schemas/CreateCartWorkflowInput.ts +++ /dev/null @@ -1,262 +0,0 @@ -/** - * @schema CreateCartWorkflowInput - * type: object - * description: SUMMARY - * x-schemaName: CreateCartWorkflowInput - * properties: - * region_id: - * type: string - * title: region_id - * description: The cart's region id. - * customer_id: - * type: string - * title: customer_id - * description: The cart's customer id. - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The cart's sales channel id. - * email: - * type: string - * title: email - * description: The cart's email. - * format: email - * currency_code: - * type: string - * title: currency_code - * description: The cart's currency code. - * shipping_address_id: - * type: string - * title: shipping_address_id - * description: The cart's shipping address id. - * billing_address_id: - * type: string - * title: billing_address_id - * description: The cart's billing address id. - * shipping_address: - * oneOf: - * - type: string - * title: shipping_address - * description: The cart's shipping address. - * - type: object - * description: The cart's shipping address. - * x-schemaName: CreateCartAddress - * properties: - * first_name: - * type: string - * title: first_name - * description: The shipping address's first name. - * last_name: - * type: string - * title: last_name - * description: The shipping address's last name. - * phone: - * type: string - * title: phone - * description: The shipping address's phone. - * company: - * type: string - * title: company - * description: The shipping address's company. - * address_1: - * type: string - * title: address_1 - * description: The shipping address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The shipping address's address 2. - * city: - * type: string - * title: city - * description: The shipping address's city. - * country_code: - * type: string - * title: country_code - * description: The shipping address's country code. - * province: - * type: string - * title: province - * description: The shipping address's province. - * postal_code: - * type: string - * title: postal_code - * description: The shipping address's postal code. - * metadata: - * type: object - * description: The shipping address's metadata. - * properties: {} - * billing_address: - * oneOf: - * - type: string - * title: billing_address - * description: The cart's billing address. - * - type: object - * description: The cart's billing address. - * x-schemaName: CreateCartAddress - * properties: - * 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. - * properties: {} - * metadata: - * type: object - * description: The cart's metadata. - * properties: {} - * items: - * type: array - * description: The cart's items. - * items: - * type: object - * description: The item's items. - * x-schemaName: CreateCartCreateLineItem - * required: - * - quantity - * - variant_id - * properties: - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * variant_id: - * type: string - * title: variant_id - * description: The item's variant 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. - * product_id: - * type: string - * title: product_id - * description: The item's product id. - * product_title: - * type: string - * title: product_title - * description: The item's product title. - * product_description: - * type: string - * title: product_description - * description: The item's product description. - * product_subtitle: - * type: string - * title: product_subtitle - * description: The item's product subtitle. - * product_type: - * type: string - * title: product_type - * description: The item's product type. - * product_collection: - * type: string - * title: product_collection - * description: The item's product collection. - * product_handle: - * type: string - * title: product_handle - * description: The item's product handle. - * variant_sku: - * type: string - * title: variant_sku - * description: The item's variant sku. - * variant_barcode: - * type: string - * title: variant_barcode - * description: The item's variant barcode. - * variant_title: - * type: string - * title: variant_title - * description: The item's variant title. - * variant_option_values: - * type: object - * description: The item's variant option values. - * properties: {} - * 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. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The item's is giftcard. - * compare_at_unit_price: - * type: number - * title: compare_at_unit_price - * description: The item's compare at unit price. - * 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. - * metadata: - * type: object - * description: The item's metadata. - * properties: {} - * promo_codes: - * type: array - * description: The cart's promo codes. - * items: - * type: string - * title: promo_codes - * description: The promo code's promo codes. - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateCustomer.ts b/docs-util/oas-output/schemas/CreateCustomer.ts deleted file mode 100644 index 6aeb7550ab..0000000000 --- a/docs-util/oas-output/schemas/CreateCustomer.ts +++ /dev/null @@ -1,102 +0,0 @@ -/** - * @schema CreateCustomer - * type: object - * description: SUMMARY - * x-schemaName: CreateCustomer - * properties: - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * phone: - * type: string - * title: phone - * description: The customer's phone. - * created_by: - * type: string - * title: created_by - * description: The customer's created by. - * addresses: - * type: array - * description: The customer's addresses. - * items: - * type: object - * description: The address's addresses. - * x-schemaName: CreateCustomerAddress - * properties: - * address_name: - * type: string - * title: address_name - * description: The address's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The address's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The address's is default billing. - * company: - * type: string - * title: company - * description: The address's company. - * first_name: - * type: string - * title: first_name - * description: The address's first name. - * last_name: - * type: string - * title: last_name - * description: The address's last name. - * address_1: - * type: string - * title: address_1 - * description: The address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The address's address 2. - * city: - * type: string - * title: city - * description: The address's city. - * country_code: - * type: string - * title: country_code - * description: The address's country code. - * province: - * type: string - * title: province - * description: The address's province. - * postal_code: - * type: string - * title: postal_code - * description: The address's postal code. - * phone: - * type: string - * title: phone - * description: The address's phone. - * metadata: - * type: object - * description: The address's metadata. - * properties: {} - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateCustomerAddress.ts b/docs-util/oas-output/schemas/CreateCustomerAddress.ts deleted file mode 100644 index 8a28c1fe3e..0000000000 --- a/docs-util/oas-output/schemas/CreateCustomerAddress.ts +++ /dev/null @@ -1,71 +0,0 @@ -/** - * @schema CreateCustomerAddress - * type: object - * description: SUMMARY - * x-schemaName: CreateCustomerAddress - * required: - * - customer_id - * properties: - * address_name: - * type: string - * title: address_name - * description: The customer's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. - * customer_id: - * type: string - * title: customer_id - * description: The customer's customer id. - * company: - * type: string - * title: company - * description: The customer's company. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * address_1: - * type: string - * title: address_1 - * description: The customer's address 1. - * address_2: - * type: string - * title: address_2 - * description: The customer's address 2. - * city: - * type: string - * title: city - * description: The customer's city. - * country_code: - * type: string - * title: country_code - * description: The customer's country code. - * province: - * type: string - * title: province - * description: The customer's province. - * postal_code: - * type: string - * title: postal_code - * description: The customer's postal code. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateCustomerGroup.ts b/docs-util/oas-output/schemas/CreateCustomerGroup.ts deleted file mode 100644 index 573c209205..0000000000 --- a/docs-util/oas-output/schemas/CreateCustomerGroup.ts +++ /dev/null @@ -1,23 +0,0 @@ -/** - * @schema CreateCustomerGroup - * type: object - * description: SUMMARY - * x-schemaName: CreateCustomerGroup - * required: - * - name - * properties: - * name: - * type: string - * title: name - * description: The customer group's name. - * metadata: - * type: object - * description: The customer group's metadata. - * properties: {} - * created_by: - * type: string - * title: created_by - * description: The customer group's created by. - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateInvite.ts b/docs-util/oas-output/schemas/CreateInvite.ts deleted file mode 100644 index 2244a1f8c2..0000000000 --- a/docs-util/oas-output/schemas/CreateInvite.ts +++ /dev/null @@ -1,24 +0,0 @@ -/** - * @schema CreateInvite - * type: object - * description: SUMMARY - * x-schemaName: CreateInvite - * required: - * - email - * properties: - * email: - * type: string - * title: email - * description: The invite's email. - * format: email - * accepted: - * type: boolean - * title: accepted - * description: The invite's accepted. - * metadata: - * type: object - * description: The invite's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateProduct.ts b/docs-util/oas-output/schemas/CreateProduct.ts deleted file mode 100644 index 3b84d26d69..0000000000 --- a/docs-util/oas-output/schemas/CreateProduct.ts +++ /dev/null @@ -1,268 +0,0 @@ -/** - * @schema CreateProduct - * type: object - * description: SUMMARY - * x-schemaName: CreateProduct - * required: - * - title - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * subtitle: - * type: string - * title: subtitle - * description: The product's subtitle. - * description: - * type: string - * title: description - * description: The product's description. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The product's is giftcard. - * discountable: - * type: boolean - * title: discountable - * description: The product's discountable. - * images: - * oneOf: - * - type: array - * description: The product's images. - * items: - * type: string - * title: images - * description: The image's images. - * - type: array - * description: The product's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * id: - * type: string - * title: id - * description: The image's ID. - * url: - * type: string - * title: url - * description: The image's url. - * thumbnail: - * type: string - * title: thumbnail - * description: The product's thumbnail. - * handle: - * type: string - * title: handle - * description: The product's handle. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * type: - * $ref: "#/components/schemas/CreateProductType" - * type_id: - * type: string - * title: type_id - * description: The product's type id. - * collection_id: - * type: string - * title: collection_id - * description: The product's collection id. - * tags: - * type: array - * description: The product's tags. - * items: - * type: object - * description: The tag's tags. - * x-schemaName: CreateProductTag - * required: - * - value - * properties: - * value: - * type: string - * title: value - * description: The tag's value. - * categories: - * type: array - * description: The product's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * options: - * type: array - * description: The product's options. - * items: - * type: object - * description: The option's options. - * x-schemaName: CreateProductOption - * required: - * - title - * - values - * properties: - * title: - * type: string - * title: title - * description: The option's title. - * values: - * oneOf: - * - type: array - * description: The option's values. - * items: - * type: string - * title: values - * description: The value's values. - * - type: array - * description: The option's values. - * items: - * type: object - * description: The value's values. - * required: - * - value - * properties: - * value: - * type: string - * title: value - * description: The value's details. - * product_id: - * type: string - * title: product_id - * description: The option's product id. - * variants: - * type: array - * description: The product's variants. - * items: - * type: object - * description: The variant's variants. - * x-schemaName: CreateProductVariant - * required: - * - title - * properties: - * product_id: - * type: string - * title: product_id - * description: The variant's product id. - * title: - * type: string - * title: title - * description: The variant's title. - * sku: - * type: string - * title: sku - * description: The variant's sku. - * barcode: - * type: string - * title: barcode - * description: The variant's barcode. - * ean: - * type: string - * title: ean - * description: The variant's ean. - * upc: - * type: string - * title: upc - * description: The variant's upc. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The variant's allow backorder. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The variant's inventory quantity. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The variant's manage inventory. - * hs_code: - * type: string - * title: hs_code - * description: The variant's hs code. - * origin_country: - * type: string - * title: origin_country - * description: The variant's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The variant's mid code. - * material: - * type: string - * title: material - * description: The variant's material. - * weight: - * type: number - * title: weight - * description: The variant's weight. - * length: - * type: number - * title: length - * description: The variant's length. - * height: - * type: number - * title: height - * description: The variant's height. - * width: - * type: number - * title: width - * description: The variant's width. - * options: - * type: object - * description: The variant's options. - * properties: {} - * metadata: - * type: object - * description: The variant's metadata. - * properties: {} - * width: - * type: number - * title: width - * description: The product's width. - * height: - * type: number - * title: height - * description: The product's height. - * length: - * type: number - * title: length - * description: The product's length. - * weight: - * type: number - * title: weight - * description: The product's weight. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * material: - * type: string - * title: material - * description: The product's material. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * metadata: - * type: object - * description: The product's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateProductCollection.ts b/docs-util/oas-output/schemas/CreateProductCollection.ts deleted file mode 100644 index 45b18b8c2a..0000000000 --- a/docs-util/oas-output/schemas/CreateProductCollection.ts +++ /dev/null @@ -1,30 +0,0 @@ -/** - * @schema CreateProductCollection - * type: object - * description: SUMMARY - * x-schemaName: CreateProductCollection - * required: - * - title - * properties: - * title: - * type: string - * title: title - * description: The collection's title. - * handle: - * type: string - * title: handle - * description: The collection's handle. - * product_ids: - * type: array - * description: The collection's product ids. - * items: - * type: string - * title: product_ids - * description: The product id's product ids. - * metadata: - * type: object - * description: The collection's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateProductOption.ts b/docs-util/oas-output/schemas/CreateProductOption.ts deleted file mode 100644 index 6b06092b3b..0000000000 --- a/docs-util/oas-output/schemas/CreateProductOption.ts +++ /dev/null @@ -1,40 +0,0 @@ -/** - * @schema CreateProductOption - * type: object - * description: SUMMARY - * x-schemaName: CreateProductOption - * required: - * - title - * - values - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * values: - * oneOf: - * - type: array - * description: The product's values. - * items: - * type: string - * title: values - * description: The value's values. - * - type: array - * description: The product's values. - * items: - * type: object - * description: The value's values. - * required: - * - value - * properties: - * value: - * type: string - * title: value - * description: The value's details. - * product_id: - * type: string - * title: product_id - * description: The product's product id. - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateProductVariant.ts b/docs-util/oas-output/schemas/CreateProductVariant.ts deleted file mode 100644 index a233b18ddf..0000000000 --- a/docs-util/oas-output/schemas/CreateProductVariant.ts +++ /dev/null @@ -1,87 +0,0 @@ -/** - * @schema CreateProductVariant - * type: object - * description: SUMMARY - * x-schemaName: CreateProductVariant - * required: - * - title - * properties: - * product_id: - * type: string - * title: product_id - * description: The product's product id. - * title: - * type: string - * title: title - * description: The product's title. - * sku: - * type: string - * title: sku - * description: The product's sku. - * barcode: - * type: string - * title: barcode - * description: The product's barcode. - * ean: - * type: string - * title: ean - * description: The product's ean. - * upc: - * type: string - * title: upc - * description: The product's upc. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The product's allow backorder. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The product's inventory quantity. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The product's manage inventory. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * material: - * type: string - * title: material - * description: The product's material. - * weight: - * type: number - * title: weight - * description: The product's weight. - * length: - * type: number - * title: length - * description: The product's length. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * options: - * type: object - * description: The product's options. - * properties: {} - * metadata: - * type: object - * description: The product's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CreatePromotion.ts b/docs-util/oas-output/schemas/CreatePromotion.ts deleted file mode 100644 index a89e2a410b..0000000000 --- a/docs-util/oas-output/schemas/CreatePromotion.ts +++ /dev/null @@ -1,74 +0,0 @@ -/** - * @schema CreatePromotion - * type: object - * description: SUMMARY - * x-schemaName: CreatePromotion - * required: - * - code - * - type - * properties: - * code: - * type: string - * title: code - * description: The promotion's code. - * type: - * type: string - * enum: - * - standard - * - buyget - * is_automatic: - * type: boolean - * title: is_automatic - * description: The promotion's is automatic. - * application_method: - * $ref: "#/components/schemas/CreateApplicationMethod" - * rules: - * type: array - * description: The promotion's rules. - * items: - * type: object - * description: The rule's rules. - * x-schemaName: CreatePromotionRule - * required: - * - attribute - * - operator - * - values - * properties: - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * operator: - * type: string - * enum: - * - gt - * - lt - * - eq - * - ne - * - in - * - lte - * - gte - * values: - * oneOf: - * - type: string - * title: values - * description: The rule's values. - * - type: array - * description: The rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * campaign: - * $ref: "#/components/schemas/CreateCampaign" - * campaign_id: - * type: string - * title: campaign_id - * description: The promotion's campaign id. - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateRegion.ts b/docs-util/oas-output/schemas/CreateRegion.ts deleted file mode 100644 index f8d3fe207a..0000000000 --- a/docs-util/oas-output/schemas/CreateRegion.ts +++ /dev/null @@ -1,35 +0,0 @@ -/** - * @schema CreateRegion - * type: object - * description: SUMMARY - * x-schemaName: CreateRegion - * required: - * - name - * - currency_code - * properties: - * name: - * type: string - * title: name - * description: The region's name. - * currency_code: - * type: string - * title: currency_code - * description: The region's currency code. - * automatic_taxes: - * type: boolean - * title: automatic_taxes - * description: The region's automatic taxes. - * countries: - * type: array - * description: The region's countries. - * items: - * type: string - * title: countries - * description: The country's countries. - * metadata: - * type: object - * description: The region's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateSalesChannel.ts b/docs-util/oas-output/schemas/CreateSalesChannel.ts deleted file mode 100644 index 5bdfd5ecff..0000000000 --- a/docs-util/oas-output/schemas/CreateSalesChannel.ts +++ /dev/null @@ -1,23 +0,0 @@ -/** - * @schema CreateSalesChannel - * type: object - * description: SUMMARY - * x-schemaName: CreateSalesChannel - * required: - * - name - * properties: - * name: - * type: string - * title: name - * description: The sales channel's name. - * description: - * type: string - * title: description - * description: The sales channel's description. - * is_disabled: - * type: boolean - * title: is_disabled - * description: The sales channel's is disabled. - * -*/ - diff --git a/docs-util/oas-output/schemas/CreateUser.ts b/docs-util/oas-output/schemas/CreateUser.ts deleted file mode 100644 index 30896463fc..0000000000 --- a/docs-util/oas-output/schemas/CreateUser.ts +++ /dev/null @@ -1,32 +0,0 @@ -/** - * @schema CreateUser - * type: object - * description: SUMMARY - * x-schemaName: CreateUser - * required: - * - email - * properties: - * email: - * type: string - * title: email - * description: The user's email. - * format: email - * first_name: - * type: string - * title: first_name - * description: The user's first name. - * last_name: - * type: string - * title: last_name - * description: The user's last name. - * avatar_url: - * type: string - * title: avatar_url - * description: The user's avatar url. - * metadata: - * type: object - * description: The user's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CustomerAddress.ts b/docs-util/oas-output/schemas/CustomerAddress.ts deleted file mode 100644 index 1e43abef56..0000000000 --- a/docs-util/oas-output/schemas/CustomerAddress.ts +++ /dev/null @@ -1,81 +0,0 @@ -/** - * @schema CustomerAddress - * type: object - * description: SUMMARY - * x-schemaName: CustomerAddress - * properties: - * id: - * type: string - * title: id - * description: The customer's ID. - * address_name: - * type: string - * title: address_name - * description: The customer's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. - * customer_id: - * type: string - * title: customer_id - * description: The customer's customer id. - * company: - * type: string - * title: company - * description: The customer's company. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * address_1: - * type: string - * title: address_1 - * description: The customer's address 1. - * address_2: - * type: string - * title: address_2 - * description: The customer's address 2. - * city: - * type: string - * title: city - * description: The customer's city. - * country_code: - * type: string - * title: country_code - * description: The customer's country code. - * province: - * type: string - * title: province - * description: The customer's province. - * postal_code: - * type: string - * title: postal_code - * description: The customer's postal code. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} - * created_at: - * type: string - * title: created_at - * description: The customer's created at. - * updated_at: - * type: string - * title: updated_at - * description: The customer's updated at. - * -*/ - diff --git a/docs-util/oas-output/schemas/CustomerGroupUpdatableFields.ts b/docs-util/oas-output/schemas/CustomerGroupUpdatableFields.ts deleted file mode 100644 index f775ba6915..0000000000 --- a/docs-util/oas-output/schemas/CustomerGroupUpdatableFields.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * @schema CustomerGroupUpdatableFields - * type: object - * description: SUMMARY - * x-schemaName: CustomerGroupUpdatableFields - * properties: - * name: - * type: string - * title: name - * description: The customer group's name. - * metadata: - * type: object - * description: The customer group's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/CustomerUpdatableFields.ts b/docs-util/oas-output/schemas/CustomerUpdatableFields.ts deleted file mode 100644 index b48ebd96e5..0000000000 --- a/docs-util/oas-output/schemas/CustomerUpdatableFields.ts +++ /dev/null @@ -1,34 +0,0 @@ -/** - * @schema CustomerUpdatableFields - * type: object - * description: SUMMARY - * x-schemaName: CustomerUpdatableFields - * properties: - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/StorePostCartsCartTaxesReq.ts b/docs-util/oas-output/schemas/StorePostCartsCartTaxesReq.ts deleted file mode 100644 index 3069349de4..0000000000 --- a/docs-util/oas-output/schemas/StorePostCartsCartTaxesReq.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * @schema StorePostCartsCartTaxesReq - * type: object - * description: SUMMARY - * x-schemaName: StorePostCartsCartTaxesReq - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts b/docs-util/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts index 1181a27c6c..cdb50df41e 100644 --- a/docs-util/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts +++ b/docs-util/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts @@ -10,182 +10,7 @@ * type: string * title: provider_id * description: The payment collection's provider id. - * context: - * type: object - * description: The payment collection's context. - * properties: - * billing_address: - * type: object - * description: The context's billing address. - * properties: - * id: - * type: string - * title: id - * description: The billing address's ID. - * 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. - * company: - * type: string - * title: company - * description: The billing address's company. - * country_code: - * type: string - * title: country_code - * description: The billing address's country code. - * city: - * type: string - * title: city - * description: The billing address's city. - * phone: - * type: string - * title: phone - * description: The billing address's phone. - * postal_code: - * type: string - * title: postal_code - * description: The billing address's postal code. - * province: - * type: string - * title: province - * description: The billing address's province. - * metadata: - * type: object - * description: The billing address's metadata. - * properties: {} - * 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 - * deleted_at: - * oneOf: - * - type: string - * title: deleted_at - * description: The billing address's deleted at. - * - type: string - * title: deleted_at - * description: The billing address's deleted at. - * format: date-time - * email: - * type: string - * title: email - * description: The context's email. - * format: email - * resource_id: - * type: string - * title: resource_id - * description: The context's resource id. - * customer: - * type: object - * description: The context's customer. - * x-schemaName: Customer - * properties: - * id: - * type: string - * title: id - * description: The customer's ID. - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * default_billing_address_id: - * type: string - * title: default_billing_address_id - * description: The customer's default billing address id. - * default_shipping_address_id: - * type: string - * title: default_shipping_address_id - * description: The customer's default shipping address id. - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * addresses: - * type: array - * description: The customer's addresses. - * items: - * type: object - * description: The address's addresses. - * x-schemaName: CustomerAddress - * properties: {} - * phone: - * type: string - * title: phone - * description: The customer's phone. - * groups: - * type: array - * description: The customer's groups. - * items: - * type: object - * description: The group's groups. - * properties: {} - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} - * created_by: - * type: string - * title: created_by - * description: The customer's created by. - * deleted_at: - * oneOf: - * - type: string - * title: deleted_at - * description: The customer's deleted at. - * - type: string - * title: deleted_at - * description: The customer's deleted at. - * format: date-time - * created_at: - * oneOf: - * - type: string - * title: created_at - * description: The customer's created at. - * - type: string - * title: created_at - * description: The customer's created at. - * format: date-time - * updated_at: - * oneOf: - * - type: string - * title: updated_at - * description: The customer's updated at. - * - type: string - * title: updated_at - * description: The customer's updated at. - * format: date-time - * extra: - * type: object - * description: The context's extra. - * properties: {} + * context: {} * data: * type: object * description: The payment collection's data. diff --git a/docs-util/oas-output/schemas/UpdateApiKey.ts b/docs-util/oas-output/schemas/UpdateApiKey.ts deleted file mode 100644 index 6b7c583b74..0000000000 --- a/docs-util/oas-output/schemas/UpdateApiKey.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema UpdateApiKey - * type: object - * description: SUMMARY - * x-schemaName: UpdateApiKey - * properties: - * title: - * type: string - * title: title - * description: The api key's title. - * -*/ - diff --git a/docs-util/oas-output/schemas/UpdateCartData.ts b/docs-util/oas-output/schemas/UpdateCartData.ts deleted file mode 100644 index d002b78d08..0000000000 --- a/docs-util/oas-output/schemas/UpdateCartData.ts +++ /dev/null @@ -1,266 +0,0 @@ -/** - * @schema UpdateCartData - * type: object - * description: SUMMARY - * x-schemaName: UpdateCartData - * properties: - * region_id: - * type: string - * title: region_id - * description: The cart's region id. - * customer_id: - * type: string - * title: customer_id - * description: The cart's customer id. - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The cart's sales channel id. - * email: - * type: string - * title: email - * description: The cart's email. - * format: email - * currency_code: - * type: string - * title: currency_code - * description: The cart's currency code. - * shipping_address_id: - * type: string - * title: shipping_address_id - * description: The cart's shipping address id. - * billing_address_id: - * type: string - * title: billing_address_id - * description: The cart's billing address id. - * billing_address: - * oneOf: - * - type: object - * description: The cart's billing address. - * x-schemaName: CreateAddress - * properties: - * customer_id: - * type: string - * title: customer_id - * description: The billing address's customer id. - * company: - * type: string - * title: company - * description: The billing address's company. - * 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. - * 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. - * phone: - * type: string - * title: phone - * description: The billing address's phone. - * metadata: - * type: object - * description: The billing address's metadata. - * properties: {} - * - type: object - * description: The cart's billing address. - * x-schemaName: UpdateAddress - * required: - * - id - * 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. - * company: - * type: string - * title: company - * description: The billing address's company. - * 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. - * 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. - * phone: - * type: string - * title: phone - * description: The billing address's phone. - * metadata: - * type: object - * description: The billing address's metadata. - * properties: {} - * shipping_address: - * oneOf: - * - type: object - * description: The cart's shipping address. - * x-schemaName: CreateAddress - * properties: - * customer_id: - * type: string - * title: customer_id - * description: The shipping address's customer id. - * company: - * type: string - * title: company - * description: The shipping address's company. - * first_name: - * type: string - * title: first_name - * description: The shipping address's first name. - * last_name: - * type: string - * title: last_name - * description: The shipping address's last name. - * address_1: - * type: string - * title: address_1 - * description: The shipping address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The shipping address's address 2. - * city: - * type: string - * title: city - * description: The shipping address's city. - * country_code: - * type: string - * title: country_code - * description: The shipping address's country code. - * province: - * type: string - * title: province - * description: The shipping address's province. - * postal_code: - * type: string - * title: postal_code - * description: The shipping address's postal code. - * phone: - * type: string - * title: phone - * description: The shipping address's phone. - * metadata: - * type: object - * description: The shipping address's metadata. - * properties: {} - * - type: object - * description: The cart's shipping address. - * x-schemaName: UpdateAddress - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The shipping address's ID. - * customer_id: - * type: string - * title: customer_id - * description: The shipping address's customer id. - * company: - * type: string - * title: company - * description: The shipping address's company. - * first_name: - * type: string - * title: first_name - * description: The shipping address's first name. - * last_name: - * type: string - * title: last_name - * description: The shipping address's last name. - * address_1: - * type: string - * title: address_1 - * description: The shipping address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The shipping address's address 2. - * city: - * type: string - * title: city - * description: The shipping address's city. - * country_code: - * type: string - * title: country_code - * description: The shipping address's country code. - * province: - * type: string - * title: province - * description: The shipping address's province. - * postal_code: - * type: string - * title: postal_code - * description: The shipping address's postal code. - * phone: - * type: string - * title: phone - * description: The shipping address's phone. - * metadata: - * type: object - * description: The shipping address's metadata. - * properties: {} - * metadata: - * type: object - * description: The cart's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/UpdateProduct.ts b/docs-util/oas-output/schemas/UpdateProduct.ts deleted file mode 100644 index c55f800368..0000000000 --- a/docs-util/oas-output/schemas/UpdateProduct.ts +++ /dev/null @@ -1,264 +0,0 @@ -/** - * @schema UpdateProduct - * type: object - * description: SUMMARY - * x-schemaName: UpdateProduct - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * subtitle: - * type: string - * title: subtitle - * description: The product's subtitle. - * description: - * type: string - * title: description - * description: The product's description. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The product's is giftcard. - * discountable: - * type: boolean - * title: discountable - * description: The product's discountable. - * images: - * oneOf: - * - type: array - * description: The product's images. - * items: - * type: string - * title: images - * description: The image's images. - * - type: array - * description: The product's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * id: - * type: string - * title: id - * description: The image's ID. - * url: - * type: string - * title: url - * description: The image's url. - * thumbnail: - * type: string - * title: thumbnail - * description: The product's thumbnail. - * handle: - * type: string - * title: handle - * description: The product's handle. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * type: - * $ref: "#/components/schemas/CreateProductType" - * type_id: - * type: string - * title: type_id - * description: The product's type id. - * collection_id: - * type: string - * title: collection_id - * description: The product's collection id. - * tags: - * type: array - * description: The product's tags. - * items: - * type: object - * description: The tag's tags. - * x-schemaName: CreateProductTag - * required: - * - value - * properties: - * value: - * type: string - * title: value - * description: The tag's value. - * categories: - * type: array - * description: The product's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * options: - * type: array - * description: The product's options. - * items: - * type: object - * description: The option's options. - * x-schemaName: CreateProductOption - * required: - * - title - * - values - * properties: - * title: - * type: string - * title: title - * description: The option's title. - * values: - * oneOf: - * - type: array - * description: The option's values. - * items: - * type: string - * title: values - * description: The value's values. - * - type: array - * description: The option's values. - * items: - * type: object - * description: The value's values. - * required: - * - value - * properties: - * value: - * type: string - * title: value - * description: The value's details. - * product_id: - * type: string - * title: product_id - * description: The option's product id. - * variants: - * type: array - * description: The product's variants. - * items: - * type: object - * description: The variant's variants. - * x-schemaName: UpsertProductVariant - * properties: - * id: - * type: string - * title: id - * description: The variant's ID. - * title: - * type: string - * title: title - * description: The variant's title. - * sku: - * type: string - * title: sku - * description: The variant's sku. - * barcode: - * type: string - * title: barcode - * description: The variant's barcode. - * ean: - * type: string - * title: ean - * description: The variant's ean. - * upc: - * type: string - * title: upc - * description: The variant's upc. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The variant's allow backorder. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The variant's inventory quantity. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The variant's manage inventory. - * hs_code: - * type: string - * title: hs_code - * description: The variant's hs code. - * origin_country: - * type: string - * title: origin_country - * description: The variant's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The variant's mid code. - * material: - * type: string - * title: material - * description: The variant's material. - * weight: - * type: number - * title: weight - * description: The variant's weight. - * length: - * type: number - * title: length - * description: The variant's length. - * height: - * type: number - * title: height - * description: The variant's height. - * width: - * type: number - * title: width - * description: The variant's width. - * options: - * type: object - * description: The variant's options. - * properties: {} - * metadata: - * type: object - * description: The variant's metadata. - * properties: {} - * width: - * type: number - * title: width - * description: The product's width. - * height: - * type: number - * title: height - * description: The product's height. - * length: - * type: number - * title: length - * description: The product's length. - * weight: - * type: number - * title: weight - * description: The product's weight. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * material: - * type: string - * title: material - * description: The product's material. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * metadata: - * type: object - * description: The product's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/UpdateProductCollection.ts b/docs-util/oas-output/schemas/UpdateProductCollection.ts deleted file mode 100644 index 658118940f..0000000000 --- a/docs-util/oas-output/schemas/UpdateProductCollection.ts +++ /dev/null @@ -1,32 +0,0 @@ -/** - * @schema UpdateProductCollection - * type: object - * description: SUMMARY - * x-schemaName: UpdateProductCollection - * properties: - * value: - * type: string - * title: value - * description: The collection's value. - * title: - * type: string - * title: title - * description: The collection's title. - * handle: - * type: string - * title: handle - * description: The collection's handle. - * product_ids: - * type: array - * description: The collection's product ids. - * items: - * type: string - * title: product_ids - * description: The product id's product ids. - * metadata: - * type: object - * description: The collection's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/UpdateProductOption.ts b/docs-util/oas-output/schemas/UpdateProductOption.ts deleted file mode 100644 index ceb007d92d..0000000000 --- a/docs-util/oas-output/schemas/UpdateProductOption.ts +++ /dev/null @@ -1,37 +0,0 @@ -/** - * @schema UpdateProductOption - * type: object - * description: SUMMARY - * x-schemaName: UpdateProductOption - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * values: - * oneOf: - * - type: array - * description: The product's values. - * items: - * type: string - * title: values - * description: The value's values. - * - type: array - * description: The product's values. - * items: - * type: object - * description: The value's values. - * required: - * - value - * properties: - * value: - * type: string - * title: value - * description: The value's details. - * product_id: - * type: string - * title: product_id - * description: The product's product id. - * -*/ - diff --git a/docs-util/oas-output/schemas/UpdateProductVariant.ts b/docs-util/oas-output/schemas/UpdateProductVariant.ts deleted file mode 100644 index e6f917033b..0000000000 --- a/docs-util/oas-output/schemas/UpdateProductVariant.ts +++ /dev/null @@ -1,81 +0,0 @@ -/** - * @schema UpdateProductVariant - * type: object - * description: SUMMARY - * x-schemaName: UpdateProductVariant - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * sku: - * type: string - * title: sku - * description: The product's sku. - * barcode: - * type: string - * title: barcode - * description: The product's barcode. - * ean: - * type: string - * title: ean - * description: The product's ean. - * upc: - * type: string - * title: upc - * description: The product's upc. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The product's allow backorder. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The product's inventory quantity. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The product's manage inventory. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * material: - * type: string - * title: material - * description: The product's material. - * weight: - * type: number - * title: weight - * description: The product's weight. - * length: - * type: number - * title: length - * description: The product's length. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * options: - * type: object - * description: The product's options. - * properties: {} - * metadata: - * type: object - * description: The product's metadata. - * properties: {} - * -*/ - diff --git a/docs-util/oas-output/schemas/UpdateRegion.ts b/docs-util/oas-output/schemas/UpdateRegion.ts deleted file mode 100644 index 75ed18047e..0000000000 --- a/docs-util/oas-output/schemas/UpdateRegion.ts +++ /dev/null @@ -1,32 +0,0 @@ -/** - * @schema UpdateRegion - * type: object - * description: SUMMARY - * x-schemaName: UpdateRegion - * properties: - * name: - * type: string - * title: name - * description: The region's name. - * currency_code: - * type: string - * title: currency_code - * description: The region's currency code. - * automatic_taxes: - * type: boolean - * title: automatic_taxes - * description: The region's automatic taxes. - * countries: - * type: array - * description: The region's countries. - * items: - * type: string - * title: countries - * description: The country's countries. - * metadata: - * type: object - * description: The region's metadata. - * properties: {} - * -*/ -