From 1a63209290e8af825cc3ce194c9759f4628ab040 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 3 Sep 2024 09:45:11 +0300 Subject: [PATCH] oas: [8/n] improve admin OAS (#8945) Improve the OAS of admin API routes [8/n] --- .../admin/get_admin_draft-orders.ts | 514 ++++++++++++++++++ .../operations/admin/post_admin_api-keys.ts | 8 +- .../admin/post_admin_api-keys_[id].ts | 6 +- .../admin/post_admin_api-keys_[id]_revoke.ts | 8 +- ...post_admin_api-keys_[id]_sales-channels.ts | 17 +- .../operations/admin/post_admin_campaigns.ts | 26 +- .../admin/post_admin_campaigns_[id].ts | 18 +- .../post_admin_campaigns_[id]_promotions.ts | 15 +- .../operations/admin/post_admin_claims.ts | 4 +- .../admin/post_admin_claims_[id]_cancel.ts | 4 +- .../post_admin_claims_[id]_claim-items.ts | 5 +- ...min_claims_[id]_claim-items_[action_id].ts | 9 +- .../post_admin_claims_[id]_inbound_items.ts | 6 +- ...n_claims_[id]_inbound_items_[action_id].ts | 10 +- ...min_claims_[id]_inbound_shipping-method.ts | 6 +- ...id]_inbound_shipping-method_[action_id].ts | 10 +- .../post_admin_claims_[id]_outbound_items.ts | 6 +- ..._claims_[id]_outbound_items_[action_id].ts | 10 +- ...in_claims_[id]_outbound_shipping-method.ts | 6 +- ...d]_outbound_shipping-method_[action_id].ts | 10 +- .../admin/post_admin_claims_[id]_request.ts | 5 +- .../post_admin_collections_[id]_products.ts | 15 +- ...st_admin_customer-groups_[id]_customers.ts | 15 +- .../operations/admin/post_admin_customers.ts | 6 +- .../admin/post_admin_customers_[id].ts | 6 +- .../post_admin_customers_[id]_addresses.ts | 39 +- ...n_customers_[id]_addresses_[address_id].ts | 39 +- .../admin/post_admin_draft-orders.ts | 64 ++- .../operations/admin/post_admin_exchanges.ts | 2 +- .../admin/post_admin_exchanges_[id]_cancel.ts | 4 +- ...post_admin_exchanges_[id]_inbound_items.ts | 5 +- ...xchanges_[id]_inbound_items_[action_id].ts | 10 +- ..._exchanges_[id]_inbound_shipping-method.ts | 5 +- ...id]_inbound_shipping-method_[action_id].ts | 10 +- ...ost_admin_exchanges_[id]_outbound_items.ts | 4 +- ...changes_[id]_outbound_items_[action_id].ts | 10 +- ...exchanges_[id]_outbound_shipping-method.ts | 5 +- ...d]_outbound_shipping-method_[action_id].ts | 10 +- .../post_admin_exchanges_[id]_request.ts | 4 +- ...min_fulfillment-sets_[id]_service-zones.ts | 25 +- ...lment-sets_[id]_service-zones_[zone_id].ts | 35 +- 41 files changed, 802 insertions(+), 214 deletions(-) diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts index d323ddcb3d..e2f509c095 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts @@ -913,6 +913,520 @@ * items: * type: object * title: $or + * - name: sales_channel_id + * in: query + * description: Filter by the associated sales channels to retrieve its draft orders. + * required: false + * schema: + * type: array + * description: Filter by the associated sales channels to retrieve its draft orders. + * items: + * type: string + * title: sales_channel_id + * description: A sales channel's ID. + * - name: fulfillment_status + * in: query + * description: Filter by the fulfillment status of the draft order. + * required: false + * schema: + * type: array + * description: Filter by the fulfillment status of the draft order. + * items: + * type: string + * title: fulfillment_status + * description: The fulfillment status's details. + * - name: payment_status + * in: query + * description: Filter by the payment status of the draft order. + * required: false + * schema: + * type: array + * description: Filter by the payment status of the draft order. + * items: + * type: string + * title: payment_status + * description: The payment status's details. + * - name: region_id + * in: query + * description: Filter by region IDs to retrieve their associated draft orders. + * required: false + * schema: + * type: array + * description: Filter by region IDs to retrieve their associated draft orders. + * items: + * type: string + * title: region_id + * description: A region's ID. + * - name: q + * in: query + * description: Search term to filter the order's searchable properties. + * required: false + * schema: + * type: string + * title: q + * description: Search term to filter the order's searchable properties. + * - name: created_at + * in: query + * description: Filter by the draft order's creation date. + * required: false + * schema: + * type: object + * description: Filter by the draft order's creation date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: An exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value not to match. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: The value to match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not matching this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value to not match + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the values of this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The value to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching those in this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The values to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - name: updated_at + * in: query + * description: Filter by the draft order's update date. + * required: false + * schema: + * type: object + * description: Filter by the draft order's update date. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: An exact match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not equal to this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value not to match. + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter. + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * properties: + * $and: + * type: array + * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $and + * $or: + * type: array + * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + * items: + * type: object + * title: $or + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: Filter by an exact match. + * - type: array + * description: Filter by multiple exact matches. + * items: + * type: string + * title: $eq + * description: The value to match. + * $ne: + * type: string + * title: $ne + * description: Filter by values not matching this parameter. + * $in: + * type: array + * description: Filter by values in this array. + * items: + * type: string + * title: $in + * description: The value to match. + * $nin: + * type: array + * description: Filter by values not in this array. + * items: + * type: string + * title: $nin + * description: The value to not match + * $not: + * oneOf: + * - type: string + * title: $not + * description: Filter by values not matching this parameter + * - type: object + * description: Filter by values not matching the conditions in this parameter. + * - type: array + * description: Filter by values not matching the values of this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The value to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). + * - type: array + * description: Filter by values not matching those in this parameter. + * items: + * type: string + * title: $not + * description: The values to not match. + * $gt: + * type: string + * title: $gt + * description: Filter by values greater than this parameter. Useful for numbers and dates only. + * $gte: + * type: string + * title: $gte + * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + * $lt: + * type: string + * title: $lt + * description: Filter by values less than this parameter. Useful for numbers and dates only. + * $lte: + * type: string + * title: $lte + * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + * $like: + * type: string + * title: $like + * description: Apply a `like` filter. Useful for strings only. + * $re: + * type: string + * title: $re + * description: Apply a regex filter. Useful for strings only. + * $ilike: + * type: string + * title: $ilike + * description: Apply a case-insensitive `like` filter. Useful for strings only. + * $fulltext: + * type: string + * title: $fulltext + * description: Filter to apply on full-text properties. + * $overlap: + * type: array + * description: Filter arrays that have overlapping values with this parameter. + * items: + * type: string + * title: $overlap + * description: The values to match. + * $contains: + * type: array + * description: Filter arrays that contain some of the values of this parameter. + * items: + * type: string + * title: $contains + * description: The values to match. + * $contained: + * type: array + * description: Filter arrays that contain all values of this parameter. + * items: + * type: string + * title: $contained + * description: The values to match. + * $exists: + * type: boolean + * title: $exists + * description: Filter by whether a value for this parameter exists (not `null`). * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts index cd5f970756..19842b41f7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts @@ -2,7 +2,13 @@ * @oas [post] /admin/api-keys * operationId: PostApiKeys * summary: Create Api Key - * description: Create a api key. + * description: > + * Create a secret or publishable API key. + * + * A secret API key is used for admin authentication. + * + * + * A publishable API key is used by client applications to set the scope of the request. * x-authenticated: true * parameters: [] * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts index f5a11aa895..fc1ee9cd23 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts @@ -1,13 +1,13 @@ /** * @oas [post] /admin/api-keys/{id} * operationId: PostApiKeysId - * summary: Update a Api Key - * description: Update a api key's details. + * summary: Update an API Key + * description: Update an API key's details. * x-authenticated: true * parameters: * - name: id * in: path - * description: The api key's ID. + * description: The API key's ID. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts index c03ddb47ec..f32c672571 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts @@ -1,13 +1,15 @@ /** * @oas [post] /admin/api-keys/{id}/revoke * operationId: PostApiKeysIdRevoke - * summary: Add Revokes to Api Key - * description: Add a list of revokes to a api key. + * summary: Revoke API Key + * description: > + * Revokes an API key. If the API key is a secret, it can't be used for authentication anymore. If it's publishable, + * it can't be used by client applications. * x-authenticated: true * parameters: * - name: id * in: path - * description: The api key's ID. + * description: The API key's ID. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts index 644abbfd74..dd347c12c5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts @@ -1,13 +1,14 @@ /** * @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. + * summary: Manage Sales Channels of a Publishable API Key + * x-sidebar-summary: Manage Sales Channels + * description: Manage the sales channels of a publishable API key, either to associate them or remove them from the API key. * x-authenticated: true * parameters: * - name: id * in: path - * description: The api key's ID. + * description: The API key's ID. * required: true * schema: * type: string @@ -62,22 +63,22 @@ * application/json: * schema: * type: object - * description: SUMMARY + * description: The sales channels to add or remove from the publishable API key. * properties: * add: * type: array - * description: The api key's add. + * description: The sales channels to add to the publishable API key. * items: * type: string * title: add - * description: The add's details. + * description: A sales channel's ID. * remove: * type: array - * description: The api key's remove. + * description: The sales channels to remove from the publishable API key. * items: * type: string * title: remove - * description: The remove's details. + * description: A sales channel's ID. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts index 6ce381c13b..c96fcd2e10 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts @@ -57,7 +57,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The campaign's details. * required: * - name * - campaign_identifier @@ -73,14 +73,14 @@ * campaign_identifier: * type: string * title: campaign_identifier - * description: The campaign's campaign identifier. + * description: The campaign's identifier. * description: * type: string * title: description * description: The campaign's description. * budget: * type: object - * description: The campaign's budget. + * description: The campaign's budget which, when crossed, ends the campaign. * required: * - type * - limit @@ -88,47 +88,51 @@ * properties: * type: * type: string + * title: type + * description: > + * The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. + * Use `usage` to set a limit on the total number of times the campaign's promotions can be used. * enum: * - spend * - usage * limit: * type: number * title: limit - * description: The budget's limit. + * description: The campaign budget's limit. * currency_code: * type: string * title: currency_code - * description: The budget's currency code. + * description: The campaign budget's currency code. This can't be edited later. * starts_at: * type: string * title: starts_at - * description: The campaign's starts at. + * description: The campaign's start date. * format: date-time * ends_at: * type: string * title: ends_at - * description: The campaign's ends at. + * description: The campaign's end date. * format: date-time * promotions: * type: array * description: The campaign's promotions. * items: * type: object - * description: The promotion's promotions. + * description: The promotions to add to the campaign. * required: * - id * properties: * id: * type: string * title: id - * description: The promotion's ID. + * description: A promotion's ID. * - type: object - * description: SUMMARY + * description: The campaign's details. * properties: * additional_data: * type: object * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - * description: SUMMARY + * description: The campaign's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts index 0e07a76c7e..9378c141c2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -63,7 +63,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The campaign's details. * required: * - description * - starts_at @@ -76,7 +76,7 @@ * campaign_identifier: * type: string * title: campaign_identifier - * description: The campaign's campaign identifier. + * description: The campaign's identifier. * description: * type: string * title: description @@ -90,37 +90,37 @@ * limit: * type: number * title: limit - * description: The budget's limit. + * description: The campaign budget's limit. * starts_at: * type: string * title: starts_at - * description: The campaign's starts at. + * description: The campaign's start date. * format: date-time * ends_at: * type: string * title: ends_at - * description: The campaign's ends at. + * description: The campaign's end date. * format: date-time * promotions: * type: array * description: The campaign's promotions. * items: * type: object - * description: The promotion's promotions. + * description: The promotions to add to the campaign. * required: * - id * properties: * id: * type: string * title: id - * description: The promotion's ID. + * description: A promotion's ID. * - type: object - * description: SUMMARY + * description: The campaign's details. * properties: * additional_data: * type: object * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - * description: SUMMARY + * description: The campaign's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts index 6a0688706c..bc5472ac4a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/campaigns/{id}/promotions * operationId: PostCampaignsIdPromotions - * summary: Add Promotions to Campaign - * description: Add a list of promotions to a campaign. + * summary: Manage the Promotions of a Campaign + * x-sidebar-summary: Manage Promotions + * description: Manage the promotions of a campaign, either by adding them or removing them from the campaign. * x-authenticated: true * parameters: * - name: id @@ -62,22 +63,22 @@ * application/json: * schema: * type: object - * description: SUMMARY + * description: The promotions to add or remove from the campaign. * properties: * add: * type: array - * description: The campaign's add. + * description: The promotions to add to the campaign. * items: * type: string * title: add - * description: The add's details. + * description: A promotion's ID. * remove: * type: array - * description: The campaign's remove. + * description: The promotions to remove from the campaign. * items: * type: string * title: remove - * description: The remove's details. + * description: A promotion's ID. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts index bf4ea8e1e6..f49247642e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts @@ -1,8 +1,8 @@ /** * @oas [post] /admin/claims * operationId: PostClaims - * summary: Create Claim - * description: Create a claim. + * summary: Create a Claim + * description: Create a claim. The claim is still in the request state, and the changes are only applied on the order once the claim is confirmed. * x-authenticated: true * parameters: * - name: expand diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts index fc46e278db..d130519837 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts @@ -1,8 +1,8 @@ /** * @oas [post] /admin/claims/{id}/cancel * operationId: PostClaimsIdCancel - * summary: Add Cancels to Claim - * description: Add a list of cancels to a claim. + * summary: Cancel a Claim + * description: Cancel a claim and its associated return. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts index 0667a8a577..9059950963 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/claims/{id}/claim-items * operationId: PostClaimsIdClaimItems - * summary: Add Claim Items to Claim - * description: Add a list of claim items to a claim. + * summary: Add Claim Items to a Claim + * x-sidebar-summary: Add Claim Items + * description: Add order items to a claim as claim items. These claim items will have the action `WRITE_OFF_ITEM`. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts index 5c90da7ff3..c3cd95dfe4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts @@ -1,8 +1,11 @@ /** * @oas [post] /admin/claims/{id}/claim-items/{action_id} * operationId: PostClaimsIdClaimItemsAction_id - * summary: Add Claim Items to Claim - * description: Add a list of claim items to a claim. + * summary: Update a Claim Item + * description: | + * Update an order item in a claim by the ID of the item's `WRITE_OFF_ITEM` action. + * + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +16,7 @@ * type: string * - name: action_id * in: path - * description: The claim's action id. + * description: The ID of the order item's `WRITE_OFF_ITEM` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts index 1fc9b1a97c..7c14c3d0c9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items.ts @@ -1,8 +1,10 @@ /** * @oas [post] /admin/claims/{id}/inbound/items * operationId: PostClaimsIdInboundItems - * summary: Add Items to Claim - * description: Add a list of items to a claim. + * summary: Add Inbound Items to a Claim + * x-sidebar-summary: Add Inbound Items + * description: | + * Add inbound (or return) items to a claim. These inbound items will have a `RETURN_ITEM` action. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts index 6e686442e2..94031fde13 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_items_[action_id].ts @@ -1,8 +1,12 @@ /** * @oas [post] /admin/claims/{id}/inbound/items/{action_id} * operationId: PostClaimsIdInboundItemsAction_id - * summary: Add Items to Claim - * description: Add a list of items to a claim. + * summary: Update Inbound Items of a Claim + * x-sidebar-summary: Update Inbound Items + * description: | + * Update an inbound (or return) item of a claim using the `ID` of the item's `RETURN_ITEM` action. + * + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: action_id * in: path - * description: The claim's action id. + * description: The ID of the return item's `RETURN_ITEM` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts index ed31af6f33..a86c3b7b90 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method.ts @@ -1,8 +1,10 @@ /** * @oas [post] /admin/claims/{id}/inbound/shipping-method * operationId: PostClaimsIdInboundShippingMethod - * summary: Add Shipping Methods to Claim - * description: Add a list of shipping methods to a claim. + * summary: Add an Inbound Shipping Method to a Claim + * x-sidebar-summary: Add Inbound Shipping + * description: | + * Add an inbound (or return) shipping method to a claim. The inbound shipping method will have a `SHIPPING_ADD` action. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts index 2d01cb862e..5cb399e26e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -1,8 +1,12 @@ /** * @oas [post] /admin/claims/{id}/inbound/shipping-method/{action_id} * operationId: PostClaimsIdInboundShippingMethodAction_id - * summary: Add Shipping Methods to Claim - * description: Add a list of shipping methods to a claim. + * summary: Update Inbound Shipping Method of a Claim + * x-sidebar-summary: Update Inbound Shipping + * description: | + * Update the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action. + * + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: action_id * in: path - * description: The claim's action id. + * description: The ID of the shipping method's `SHIPPING_ADD` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts index 360a102487..1219b0322c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts @@ -1,8 +1,10 @@ /** * @oas [post] /admin/claims/{id}/outbound/items * operationId: PostClaimsIdOutboundItems - * summary: Add Items to Claim - * description: Add a list of items to a claim. + * summary: Add Outbound Items to a Claim + * x-sidebar-summary: Add Outbound Items + * description: | + * Add outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts index b8883eb858..33f2305f07 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts @@ -1,8 +1,12 @@ /** * @oas [post] /admin/claims/{id}/outbound/items/{action_id} * operationId: PostClaimsIdOutboundItemsAction_id - * summary: Add Items to Claim - * description: Add a list of items to a claim. + * summary: Update Outbound Item of a Claim + * x-sidebar-summary: Update Outbound Item + * description: | + * Update an outbound (or new) item of a claim using the `ID` of the item's `ITEM_ADD` action. + * + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: action_id * in: path - * description: The claim's action id. + * description: The ID of the new claim item's `ITEM_ADD` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts index 97be389861..1ba3e482e0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts @@ -1,8 +1,10 @@ /** * @oas [post] /admin/claims/{id}/outbound/shipping-method * operationId: PostClaimsIdOutboundShippingMethod - * summary: Add Shipping Methods to Claim - * description: Add a list of shipping methods to a claim. + * summary: Add Outbound Shipping Methods to a Claim + * x-sidebar-summary: Add Outbound Shipping + * description: | + * Add an outbound shipping method to a claim. The outbound shipping method will have a `SHIPPING_ADD` action. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts index 95e57f7198..705a1fc278 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -1,8 +1,12 @@ /** * @oas [post] /admin/claims/{id}/outbound/shipping-method/{action_id} * operationId: PostClaimsIdOutboundShippingMethodAction_id - * summary: Add Shipping Methods to Claim - * description: Add a list of shipping methods to a claim. + * summary: Update Outbound Shipping Method of a Claim + * x-sidebar-summary: Update Outbound Shipping + * description: | + * Update the shipping method for delivering outbound items in a claim using the `ID` of the method's `SHIPPING_ADD` action. + * + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: action_id * in: path - * description: The claim's action id. + * description: The ID of the shipping method's `SHIPPING_ADD` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts index 7dc902415a..dc89edf834 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/claims/{id}/request * operationId: PostClaimsIdRequest - * summary: Add Requests to Claim - * description: Add a list of requests to a claim. + * summary: Confirm a Claim Request + * x-sidebar-summary: Confirm Claim + * description: Confirm a claim request, applying its changes on the associated order. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts index 39f230e2f2..224894849c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/collections/{id}/products * operationId: PostCollectionsIdProducts - * summary: Add Products to Collection - * description: Add a list of products to a collection. + * summary: Manage Products of a Collection + * x-sidebar-summary: Manage Products + * description: Manage the products of a collection by adding or removing them from the collection. * x-authenticated: true * parameters: * - name: id @@ -62,22 +63,22 @@ * application/json: * schema: * type: object - * description: SUMMARY + * description: The products to add or remove. * properties: * add: * type: array - * description: The collection's add. + * description: The products to add to the collection. * items: * type: string * title: add - * description: The add's details. + * description: A product's ID. * remove: * type: array - * description: The collection's remove. + * description: The products to remove from the collection. * items: * type: string * title: remove - * description: The remove's details. + * description: A product's ID. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts index 17d3c68b43..32e1bc8970 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts @@ -1,8 +1,9 @@ /** * @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. + * summary: Manage Customers of a Customer Group + * x-sidebar-summary: Manage Customers + * description: Manage the customers of a group to add or remove them from the group. * x-authenticated: true * parameters: * - name: id @@ -62,22 +63,22 @@ * application/json: * schema: * type: object - * description: SUMMARY + * description: The customers to add or remove from the group. * properties: * add: * type: array - * description: The customer group's add. + * description: The customers to add to the group. * items: * type: string * title: add - * description: The add's details. + * description: A customer's ID. * remove: * type: array - * description: The customer group's remove. + * description: The customers to remove from the group. * items: * type: string * title: remove - * description: The remove's details. + * description: A customer's ID. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts index d5b6398820..8066d9144a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts @@ -57,7 +57,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The customer's details. * required: * - email * - company_name @@ -91,12 +91,12 @@ * type: object * description: The customer's metadata. * - type: object - * description: SUMMARY + * description: The customer's details. * properties: * additional_data: * type: object * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - * description: SUMMARY + * description: The customer's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts index 6d8e060457..fb26f3c3b4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts @@ -63,7 +63,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The customer's details. * required: * - email * - company_name @@ -97,12 +97,12 @@ * type: object * description: The customer's metadata. * - type: object - * description: SUMMARY + * description: The customer's details. * properties: * additional_data: * type: object * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - * description: SUMMARY + * description: The customer's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index 0818a7a6d4..d2ad86e9a3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/customers/{id}/addresses * operationId: PostCustomersIdAddresses - * summary: Add Addresses to Customer - * description: Add a list of addresses to a customer. + * summary: Add a Customer Address + * x-sidebar-summary: Add Address + * description: Add an address to a customer. * x-authenticated: true * parameters: * - name: id @@ -63,7 +64,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The address's details. * required: * - address_name * - company @@ -81,65 +82,65 @@ * address_name: * type: string * title: address_name - * description: The customer's address name. + * description: The name of the address. * is_default_shipping: * type: boolean * title: is_default_shipping - * description: The customer's is default shipping. + * description: Whether this address is used by default for shipping when placing an order. * is_default_billing: * type: boolean * title: is_default_billing - * description: The customer's is default billing. + * description: Whether this address is used by default for billing when placing an order. * company: * type: string * title: company - * description: The customer's company. + * description: The address's company. * first_name: * type: string * title: first_name - * description: The customer's first name. + * description: The address's first name. * last_name: * type: string * title: last_name - * description: The customer's last name. + * description: The address's last name. * address_1: * type: string * title: address_1 - * description: The customer's address 1. + * description: The address's first line. * address_2: * type: string * title: address_2 - * description: The customer's address 2. + * description: The address's second line. * city: * type: string * title: city - * description: The customer's city. + * description: The address's city. * country_code: * type: string * title: country_code - * description: The customer's country code. + * description: The address's country code. * province: * type: string * title: province - * description: The customer's province. + * description: The address's province. * postal_code: * type: string * title: postal_code - * description: The customer's postal code. + * description: The address's postal code. * phone: * type: string * title: phone - * description: The customer's phone. + * description: The address's phone. * metadata: * type: object - * description: The customer's metadata. + * description: The address's metadata. * - type: object - * description: SUMMARY + * description: The address's details. * properties: * additional_data: * type: object * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - * description: SUMMARY + * description: The address's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index 23d79bd0b9..6c24e45466 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/customers/{id}/addresses/{address_id} * operationId: PostCustomersIdAddressesAddress_id - * summary: Add Addresses to Customer - * description: Add a list of addresses to a customer. + * summary: Update a Customer's Address + * x-sidebar-summary: Update Address + * description: Update a customer address's details. * x-authenticated: true * parameters: * - name: id @@ -69,7 +70,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The address's details. * required: * - address_name * - company @@ -87,65 +88,65 @@ * address_name: * type: string * title: address_name - * description: The customer's address name. + * description: The name of the address. * is_default_shipping: * type: boolean * title: is_default_shipping - * description: The customer's is default shipping. + * description: Whether this address is used by default for shipping when placing an order. * is_default_billing: * type: boolean * title: is_default_billing - * description: The customer's is default billing. + * description: Whether this address is used by default for billing when placing an order. * company: * type: string * title: company - * description: The customer's company. + * description: The address's company. * first_name: * type: string * title: first_name - * description: The customer's first name. + * description: The address's first name. * last_name: * type: string * title: last_name - * description: The customer's last name. + * description: The address's last name. * address_1: * type: string * title: address_1 - * description: The customer's address 1. + * description: The address's first line * address_2: * type: string * title: address_2 - * description: The customer's address 2. + * description: The address's second line * city: * type: string * title: city - * description: The customer's city. + * description: The address's city. * country_code: * type: string * title: country_code - * description: The customer's country code. + * description: The address's country code. * province: * type: string * title: province - * description: The customer's province. + * description: The address's province. * postal_code: * type: string * title: postal_code - * description: The customer's postal code. + * description: The address's postal code. * phone: * type: string * title: phone - * description: The customer's phone. + * description: The address's phone. * metadata: * type: object - * description: The customer's metadata. + * description: The address's metadata. * - type: object - * description: SUMMARY + * description: The address's details. * properties: * additional_data: * type: object * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - * description: SUMMARY + * description: The address's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts index d3a38c13ce..ece06f52dc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts @@ -2,7 +2,7 @@ * @oas [post] /admin/draft-orders * operationId: PostDraftOrders * summary: Create Draft Order - * description: Create a draft order. + * description: Create a draft order. This creates an order with the `is_draft_order` property enabled. * x-authenticated: true * parameters: * - name: expand @@ -57,7 +57,7 @@ * schema: * allOf: * - type: object - * description: SUMMARY + * description: The draft order's details. * required: * - sales_channel_id * - email @@ -68,25 +68,27 @@ * - metadata * properties: * status: - * type: boolean + * type: string * title: status * description: The draft order's status. + * enum: + * - completed * sales_channel_id: * type: string * title: sales_channel_id - * description: The draft order's sales channel id. + * description: The ID of the associated sales channel. * email: * type: string * title: email - * description: The draft order's email. + * description: The email of the draft order's customer. * format: email * customer_id: * type: string * title: customer_id - * description: The draft order's customer id. + * description: The ID of the draft order's customer. * billing_address: * type: object - * description: The draft order's billing address. + * description: The billing address's details. * required: * - first_name * - last_name @@ -119,11 +121,11 @@ * address_1: * type: string * title: address_1 - * description: The billing address's address 1. + * description: The billing address's first line. * address_2: * type: string * title: address_2 - * description: The billing address's address 2. + * description: The billing address's second line. * city: * type: string * title: city @@ -178,11 +180,11 @@ * address_1: * type: string * title: address_1 - * description: The shipping address's address 1. + * description: The shipping address's first line. * address_2: * type: string * title: address_2 - * description: The shipping address's address 2. + * description: The shipping address's second line. * city: * type: string * title: city @@ -207,7 +209,7 @@ * description: The draft order's items. * items: * type: object - * description: The item's items. + * description: The item's details. * required: * - title * - sku @@ -224,7 +226,7 @@ * sku: * type: string * title: sku - * description: The item's sku. + * description: The item's SKU. * barcode: * type: string * title: barcode @@ -232,7 +234,7 @@ * variant_id: * type: string * title: variant_id - * description: The item's variant id. + * description: The ID of the associated product variant. * unit_price: * oneOf: * - type: string @@ -254,25 +256,25 @@ * precision: * type: number * title: precision - * description: The unit price's precision. + * description: The unit price's rounding precision. * quantity: * type: number * title: quantity - * description: The item's quantity. + * description: The item's ordered quantity. * metadata: * type: object * description: The item's metadata. * region_id: * type: string * title: region_id - * description: The draft order's region id. + * description: The ID of the associated region. * promo_codes: * type: array - * description: The draft order's promo codes. + * description: The promotion codes applied on the draft order. * items: * type: string * title: promo_codes - * description: The promo code's promo codes. + * description: A promotion code. * currency_code: * type: string * title: currency_code @@ -280,16 +282,14 @@ * no_notification_order: * type: boolean * title: no_notification_order - * description: The draft order's no notification order. + * description: Whether to send the customer notifications on order changes. * shipping_methods: * type: array * description: The draft order's shipping methods. * items: * type: object - * description: The shipping method's shipping methods. + * description: The shipping method's details. * required: - * - shipping_method_id - * - order_id * - name * - option_id * - amount @@ -297,11 +297,7 @@ * 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. + * description: The ID of an existing shipping method. * name: * type: string * title: name @@ -309,10 +305,12 @@ * option_id: * type: string * title: option_id - * description: The shipping method's option id. + * description: The ID of the shipping option this method is created from. * data: * type: object - * description: The shipping method's data. + * description: The shipping method's data, useful for fulfillment providers. + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property * amount: * oneOf: * - type: string @@ -334,17 +332,17 @@ * precision: * type: number * title: precision - * description: The amount's precision. + * description: The amount's rounding precision. * metadata: * type: object * description: The draft order's metadata. * - type: object - * description: SUMMARY + * description: The draft order's details. * properties: * additional_data: * type: object * description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - * description: SUMMARY + * description: The draft order's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts index 19b4b504e3..444ad38501 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts @@ -2,7 +2,7 @@ * @oas [post] /admin/exchanges * operationId: PostExchanges * summary: Create Exchange - * description: Create a exchange. + * description: Create an exchange request. Its changes aren't applied on the order until the exchange is confirmed. * x-authenticated: true * parameters: * - name: expand diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts index 182bcc0cc6..e26265cde8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts @@ -1,8 +1,8 @@ /** * @oas [post] /admin/exchanges/{id}/cancel * operationId: PostExchangesIdCancel - * summary: Add Cancels to Exchange - * description: Add a list of cancels to a exchange. + * summary: Cancel an Exchange + * description: Cancel an exchange and its associated return. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts index d5a8b41dbe..dadf22fa1b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items.ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/exchanges/{id}/inbound/items * operationId: PostExchangesIdInboundItems - * summary: Add Items to Exchange - * description: Add a list of items to a exchange. + * summary: Add Inbound Items to an Exchange + * x-sidebary-summary: Add Inbound Items + * description: Add inbound (or return) items to an exchange. These inbound items will have the action `RETURN_ITEM`. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts index 9c038ab892..b8c543fe72 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -1,8 +1,12 @@ /** * @oas [post] /admin/exchanges/{id}/inbound/items/{action_id} * operationId: PostExchangesIdInboundItemsAction_id - * summary: Add Items to Exchange - * description: Add a list of items to a exchange. + * summary: Update an Inbount Item of an Exchange + * x-sidebar-summary: Update Inbound Item + * description: | + * Update an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action. + * + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: action_id * in: path - * description: The exchange's action id. + * description: The ID of the return item's `RETURN_ITEM` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts index 19a6d711e4..a59678096c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method.ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/exchanges/{id}/inbound/shipping-method * operationId: PostExchangesIdInboundShippingMethod - * summary: Add Shipping Methods to Exchange - * description: Add a list of shipping methods to a exchange. + * summary: Add an Inbound Shipping Method to an Exchange + * x-sidebar-summary: Add Inbound Shipping + * description: Add an inbound (or return) shipping method to an exchange. The inbound shipping method will have a `SHIPPING_ADD` action. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index c320a31839..99bb7cd9dc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -1,8 +1,12 @@ /** * @oas [post] /admin/exchanges/{id}/inbound/shipping-method/{action_id} * operationId: PostExchangesIdInboundShippingMethodAction_id - * summary: Add Shipping Methods to Exchange - * description: Add a list of shipping methods to a exchange. + * summary: Update Inbound Shipping Method of an Exchange + * x-sidebar-summary: Update Inbound Shipping + * description: | + * Update the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. + * + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: action_id * in: path - * description: The exchange's action id. + * description: The ID of the shipping method's `SHIPPING_ADD` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts index 78ec551dc4..782b480c95 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts @@ -1,8 +1,8 @@ /** * @oas [post] /admin/exchanges/{id}/outbound/items * operationId: PostExchangesIdOutboundItems - * summary: Add Items to Exchange - * description: Add a list of items to a exchange. + * summary: Add Outbound Items to Exchange + * description: Add outbound (or new) items to an exchange. These outbound items will have the action `ITEM_ADD`. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts index e11cfc95a5..32190a0304 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -1,8 +1,12 @@ /** * @oas [post] /admin/exchanges/{id}/outbound/items/{action_id} * operationId: PostExchangesIdOutboundItemsAction_id - * summary: Add Items to Exchange - * description: Add a list of items to a exchange. + * summary: Update Outbound Item of an Exchange + * x-sidebar-summary: Update Outbound Item + * description: | + * Update an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action. + * + * Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: action_id * in: path - * description: The exchange's action id. + * description: The ID of the new exchange item's `ITEM_ADD` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts index 0aec88fab3..01cf292714 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts @@ -1,8 +1,9 @@ /** * @oas [post] /admin/exchanges/{id}/outbound/shipping-method * operationId: PostExchangesIdOutboundShippingMethod - * summary: Add Shipping Methods to Exchange - * description: Add a list of shipping methods to a exchange. + * summary: Add Outbound Shipping Method to Exchange + * x-sidebar-summary: Add Outbound Shipping + * description: Add an outbound shipping method to an exchange. The outbound shipping method will have a `SHIPPING_ADD` action. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index 89d945757a..d19f18758b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -1,8 +1,12 @@ /** * @oas [post] /admin/exchanges/{id}/outbound/shipping-method/{action_id} * operationId: PostExchangesIdOutboundShippingMethodAction_id - * summary: Add Shipping Methods to Exchange - * description: Add a list of shipping methods to a exchange. + * summary: Update Outbound Shipping Method of Exchange + * x-sidebar-summary: Update Outbound Shipping + * description: | + * Update the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. + * + * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. * x-authenticated: true * parameters: * - name: id @@ -13,7 +17,7 @@ * type: string * - name: action_id * in: path - * description: The exchange's action id. + * description: The ID of the shipping method's `SHIPPING_ADD` action. * required: true * schema: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts index d56e9b556d..8762d4f358 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_request.ts @@ -1,8 +1,8 @@ /** * @oas [post] /admin/exchanges/{id}/request * operationId: PostExchangesIdRequest - * summary: Add Requests to Exchange - * description: Add a list of requests to a exchange. + * summary: Confirm an Exchange + * description: Confirm an exchange request, applying its changes on the associated order. * x-authenticated: true * parameters: * - name: id diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts index b1ab77bcea..02b0be571e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts @@ -1,8 +1,9 @@ /** * @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. + * summary: Add a Service Zone to a Fulfillment Set + * x-sidebar-summary: Add Service Zone + * description: Add a service zone to a fulfillment set. * x-authenticated: true * parameters: * - name: id @@ -62,21 +63,21 @@ * application/json: * schema: * type: object - * description: SUMMARY + * description: The service zone's details. * required: * - name * properties: * name: * type: string * title: name - * description: The fulfillment set's name. + * description: The service zone's name. * geo_zones: * type: array - * description: The fulfillment set's geo zones. + * description: The service zone's geo zones. * items: * oneOf: * - type: object - * description: The geo zone's geo zones. + * description: A country geo zone. * required: * - metadata * - country_code @@ -93,8 +94,9 @@ * type: string * title: type * description: The geo zone's type. + * default: "country" * - type: object - * description: The geo zone's geo zones. + * description: A province geo zone. * required: * - metadata * - country_code @@ -112,12 +114,13 @@ * type: string * title: type * description: The geo zone's type. + * default: "province" * province_code: * type: string * title: province_code * description: The geo zone's province code. * - type: object - * description: The geo zone's geo zones. + * description: A city geo zone * required: * - metadata * - country_code @@ -136,6 +139,7 @@ * type: string * title: type * description: The geo zone's type. + * default: "city" * province_code: * type: string * title: province_code @@ -145,7 +149,7 @@ * title: city * description: The geo zone's city. * - type: object - * description: The geo zone's geo zones. + * description: A ZIP geo zone. * required: * - metadata * - country_code @@ -165,6 +169,7 @@ * type: string * title: type * description: The geo zone's type. + * default: "zip" * province_code: * type: string * title: province_code @@ -175,7 +180,7 @@ * description: The geo zone's city. * postal_expression: * type: object - * description: The geo zone's postal expression. + * description: The geo zone's postal expression or ZIP code. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 872ad20b4d..638e23aff9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -1,8 +1,9 @@ /** * @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. + * summary: Update the Service Zone of a Fulfillment Set + * x-sidebar-summary: Update Service Zone + * description: Update the details of a service zone in a fulfillment set. * x-authenticated: true * parameters: * - name: id @@ -13,7 +14,7 @@ * type: string * - name: zone_id * in: path - * description: The fulfillment set's zone id. + * description: The service zone's ID. * required: true * schema: * type: string @@ -68,21 +69,21 @@ * application/json: * schema: * type: object - * description: SUMMARY + * description: The service zone's details. * required: * - name * properties: * name: * type: string * title: name - * description: The fulfillment set's name. + * description: The service zone's name. * geo_zones: * type: array - * description: The fulfillment set's geo zones. + * description: The service zone's associated geo zones. * items: * oneOf: * - type: object - * description: The geo zone's geo zones. + * description: A country geo zone. * required: * - type * - metadata @@ -92,6 +93,7 @@ * type: string * title: type * description: The geo zone's type. + * default: "country" * metadata: * type: object * description: The geo zone's metadata. @@ -102,9 +104,9 @@ * id: * type: string * title: id - * description: The geo zone's ID. + * description: The ID of an existing geo zone. * - type: object - * description: The geo zone's geo zones. + * description: A province geo zone. * required: * - type * - metadata @@ -115,6 +117,7 @@ * type: string * title: type * description: The geo zone's type. + * default: "province" * metadata: * type: object * description: The geo zone's metadata. @@ -129,9 +132,9 @@ * id: * type: string * title: id - * description: The geo zone's ID. + * description: The ID of an existing geo zone. * - type: object - * description: The geo zone's geo zones. + * description: A city geo zone * required: * - type * - metadata @@ -143,6 +146,7 @@ * type: string * title: type * description: The geo zone's type. + * default: "city" * metadata: * type: object * description: The geo zone's metadata. @@ -161,9 +165,9 @@ * id: * type: string * title: id - * description: The geo zone's ID. + * description: The ID of an existing geo zone. * - type: object - * description: The geo zone's geo zones. + * description: A ZIP geo zone. * required: * - type * - metadata @@ -176,6 +180,7 @@ * type: string * title: type * description: The geo zone's type. + * default: "zip" * metadata: * type: object * description: The geo zone's metadata. @@ -193,11 +198,11 @@ * description: The geo zone's province code. * postal_expression: * type: object - * description: The geo zone's postal expression. + * description: The geo zone's postal expression or ZIP code. * id: * type: string * title: id - * description: The geo zone's ID. + * description: The ID of an existing geo zone. * x-codeSamples: * - lang: Shell * label: cURL