From 6294a71296ea2af1e94bff21a2d7fd196f9ded9a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 4 Mar 2025 14:10:22 +0000 Subject: [PATCH] chore(docs): Updated API Reference (automated) (#11719) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com> --- .../auth_user_{auth_provider}_update/post.sh | 3 +- .../schemas/BaseCalculatedPriceSet.yaml | 10 + .../components/schemas/OrderCreditLine.yaml | 5 + .../components/schemas/OrderReturnItem.yaml | 4 + .../schemas/StoreCalculatedPrice.yaml | 10 + .../specs/admin/openapi.full.yaml | 171 ++++-------------- .../api-reference/specs/admin/openapi.yaml | 5 + .../specs/admin/paths/admin_draft-orders.yaml | 42 ----- .../specs/admin/paths/admin_orders.yaml | 40 ---- .../specs/admin/paths/admin_returns.yaml | 40 ---- .../auth_user_{auth_provider}_update.yaml | 13 +- .../post.sh | 3 +- .../schemas/BaseCalculatedPriceSet.yaml | 10 + .../components/schemas/OrderCreditLine.yaml | 5 + .../components/schemas/OrderReturnItem.yaml | 4 + .../schemas/StoreCalculatedPrice.yaml | 10 + .../specs/store/openapi.full.yaml | 49 ++++- .../api-reference/specs/store/openapi.yaml | 5 + .../auth_customer_{auth_provider}_update.yaml | 13 +- .../admin/get_admin_draft-orders.ts | 42 ----- .../operations/admin/get_admin_orders.ts | 40 ---- .../operations/admin/get_admin_returns.ts | 40 ---- .../schemas/BaseCalculatedPriceSet.ts | 10 + .../oas-output/schemas/OrderCreditLine.ts | 5 + .../oas-output/schemas/OrderReturnItem.ts | 4 + .../schemas/StoreCalculatedPrice.ts | 10 + 26 files changed, 189 insertions(+), 404 deletions(-) diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_update/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_update/post.sh index c640049b27..03d32a9fd7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_update/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_update/post.sh @@ -1,5 +1,6 @@ -curl -X POST '{backend_url}/auth/user/emailpass/update?token=123' \ +curl -X POST '{backend_url}/auth/user/emailpass/update' \ -H 'Content-Type: application/json' \ +-H 'Authorization: Bearer {token}' \ --data-raw '{ "email": "admin@medusa-test.com", "password": "supersecret" diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml index ac22d66e39..7370a060ab 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml @@ -5,6 +5,8 @@ required: - id - calculated_amount - original_amount + - original_amount_with_tax + - original_amount_without_tax - currency_code properties: id: @@ -59,3 +61,11 @@ properties: original_price: type: object description: The original price's details. + original_amount_with_tax: + type: number + title: original_amount_with_tax + description: The amount of the original price with taxes applied. + original_amount_without_tax: + type: number + title: original_amount_without_tax + description: The amount of the original price without taxes. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml index f5ad7d673d..17b199333b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml @@ -5,6 +5,7 @@ required: - id - order_id - order + - amount - reference - reference_id - metadata @@ -44,3 +45,7 @@ properties: format: date-time title: updated_at description: The date the credit line was updated. + amount: + type: number + title: amount + description: The credit line's amount. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml index e6fc76e22f..41fd512de0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml @@ -51,3 +51,7 @@ properties: format: date-time title: updated_at description: The date the item was updated. + damaged_quantity: + type: number + title: damaged_quantity + description: The item's damaged quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCalculatedPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCalculatedPrice.yaml index 295219e59e..625ca060bb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCalculatedPrice.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCalculatedPrice.yaml @@ -5,6 +5,8 @@ required: - id - calculated_amount - original_amount + - original_amount_with_tax + - original_amount_without_tax - currency_code properties: id: @@ -120,3 +122,11 @@ properties: type: number title: max_quantity description: The maximum quantity required in the cart for the price to apply. + original_amount_with_tax: + type: number + title: original_amount_with_tax + description: The original amount with taxes applied. + original_amount_without_tax: + type: number + title: original_amount_without_tax + description: The original amount without taxes. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index dd4d689d52..ae338abeff 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -12428,48 +12428,6 @@ paths: 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. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered - - 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. - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - name: region_id in: query description: Filter by region IDs to retrieve their associated draft orders. @@ -19174,46 +19132,6 @@ paths: type: string title: sales_channel_id description: A sales channel's ID. - - name: fulfillment_status - in: query - description: Filter by the order's fulfillment status. - required: false - schema: - type: array - description: Filter by the order's fulfillment status. - items: - type: string - description: A fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered - - name: payment_status - in: query - description: Filter by the order's payment status. - required: false - schema: - type: array - description: Filter by the order's payment status. - items: - type: string - description: A payment status - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - name: region_id in: query description: Filter by region IDs to retrieve their associated orders. @@ -33752,46 +33670,6 @@ paths: type: string title: sales_channel_id description: A sales channel's ID. - - name: fulfillment_status - in: query - description: Filter by fulfillment statuses. - required: false - schema: - type: array - description: Filter by fulfillment statuses. - items: - type: string - description: A fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered - - name: payment_status - in: query - description: Filter by payment statuses. - required: false - schema: - type: array - description: Filter by payment statuses. - items: - type: string - description: A payment status. - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - name: region_id in: query description: Filter by region IDs to retrieve their associated returns. @@ -43604,11 +43482,11 @@ paths: operationId: PostActor_typeAuth_providerUpdate summary: Reset an Admin User's Password x-sidebar-summary: Reset Password - description: Reset an admin user's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword). + description: Reset an admin user's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header. externalDocs: url: https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#reset-password-route description: Learn more about this API route. - x-authenticated: false + x-authenticated: true parameters: - name: auth_provider in: path @@ -43617,12 +43495,6 @@ paths: schema: type: string example: emailpass - - name: token - in: query - description: The reset password token received using the Get Reset Password API route. - required: true - schema: - type: string requestBody: content: application/json: @@ -43637,12 +43509,15 @@ paths: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/auth/user/emailpass/update?token=123' \ + curl -X POST '{backend_url}/auth/user/emailpass/update' \ -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {token}' \ --data-raw '{ "email": "admin@medusa-test.com", "password": "supersecret" }' + security: + - reset_password: [] tags: - Auth responses: @@ -55717,6 +55592,8 @@ components: - id - calculated_amount - original_amount + - original_amount_with_tax + - original_amount_without_tax - currency_code properties: id: @@ -55766,6 +55643,14 @@ components: original_price: type: object description: The original price's details. + original_amount_with_tax: + type: number + title: original_amount_with_tax + description: The amount of the original price with taxes applied. + original_amount_without_tax: + type: number + title: original_amount_without_tax + description: The amount of the original price without taxes. BaseCapture: type: object description: The details of a captured payment. @@ -60060,6 +59945,7 @@ components: - id - order_id - order + - amount - reference - reference_id - metadata @@ -60097,6 +59983,10 @@ components: format: date-time title: updated_at description: The date the credit line was updated. + amount: + type: number + title: amount + description: The credit line's amount. OrderExchange: type: object description: The order change's exchange. @@ -60649,6 +60539,10 @@ components: format: date-time title: updated_at description: The date the item was updated. + damaged_quantity: + type: number + title: damaged_quantity + description: The item's damaged quantity. OrderShippingMethod: type: object description: The shipping method's details. @@ -61149,6 +61043,8 @@ components: - id - calculated_amount - original_amount + - original_amount_with_tax + - original_amount_without_tax - currency_code properties: id: @@ -61255,6 +61151,14 @@ components: type: number title: max_quantity description: The maximum quantity required in the cart for the price to apply. + original_amount_with_tax: + type: number + title: original_amount_with_tax + description: The original amount with taxes applied. + original_amount_without_tax: + type: number + title: original_amount_without_tax + description: The original amount without taxes. StoreCart: type: object description: The cart's details. @@ -70571,3 +70475,8 @@ components: in: cookie name: connect.sid x-displayName: Cookie Session ID + reset_password: + type: http + x-displayName: Reset Password Token + scheme: bearer + x-is-auth: false diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 23edee44a2..5ee1c8689a 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -1044,3 +1044,8 @@ components: in: cookie name: connect.sid x-displayName: Cookie Session ID + reset_password: + type: http + x-displayName: Reset Password Token + scheme: bearer + x-is-auth: false diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml index 53de5eb579..6dc8b7d2fe 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml @@ -1170,48 +1170,6 @@ get: 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. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered - - 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. - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - name: region_id in: query description: Filter by region IDs to retrieve their associated draft orders. diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml index 69d8fa22e6..2750c8df9a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -126,46 +126,6 @@ get: type: string title: sales_channel_id description: A sales channel's ID. - - name: fulfillment_status - in: query - description: Filter by the order's fulfillment status. - required: false - schema: - type: array - description: Filter by the order's fulfillment status. - items: - type: string - description: A fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered - - name: payment_status - in: query - description: Filter by the order's payment status. - required: false - schema: - type: array - description: Filter by the order's payment status. - items: - type: string - description: A payment status - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - name: region_id in: query description: Filter by region IDs to retrieve their associated orders. diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml index 51b3f4ad94..a7ba5184fb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -124,46 +124,6 @@ get: type: string title: sales_channel_id description: A sales channel's ID. - - name: fulfillment_status - in: query - description: Filter by fulfillment statuses. - required: false - schema: - type: array - description: Filter by fulfillment statuses. - items: - type: string - description: A fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered - - name: payment_status - in: query - description: Filter by payment statuses. - required: false - schema: - type: array - description: Filter by payment statuses. - items: - type: string - description: A payment status. - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - name: region_id in: query description: Filter by region IDs to retrieve their associated returns. diff --git a/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_update.yaml b/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_update.yaml index 51aad25a21..b679112dd5 100644 --- a/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_update.yaml +++ b/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_update.yaml @@ -6,11 +6,12 @@ post: Reset an admin user's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/admin#auth_postactor_typeauth_providerresetpassword). + You pass the token as a bearer token in the request's Authorization header. externalDocs: url: >- https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route#reset-password-route description: Learn more about this API route. - x-authenticated: false + x-authenticated: true parameters: - name: auth_provider in: path @@ -19,14 +20,6 @@ post: schema: type: string example: emailpass - - name: token - in: query - description: >- - The reset password token received using the Get Reset Password API - route. - required: true - schema: - type: string requestBody: content: application/json: @@ -44,6 +37,8 @@ post: label: cURL source: $ref: ../code_samples/Shell/auth_user_{auth_provider}_update/post.sh + security: + - reset_password: [] tags: - Auth responses: diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_update/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_update/post.sh index f1abe64225..e7e5f21ec5 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_update/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_update/post.sh @@ -1,5 +1,6 @@ -curl -X POST '{backend_url}/auth/customer/emailpass/update?token=123' \ +curl -X POST '{backend_url}/auth/customer/emailpass/update' \ -H 'Content-Type: application/json' \ +-H 'Authorization: Bearer {token}' \ --data-raw '{ "email": "customer@gmail.com", "password": "supersecret" diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml index ac22d66e39..7370a060ab 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml @@ -5,6 +5,8 @@ required: - id - calculated_amount - original_amount + - original_amount_with_tax + - original_amount_without_tax - currency_code properties: id: @@ -59,3 +61,11 @@ properties: original_price: type: object description: The original price's details. + original_amount_with_tax: + type: number + title: original_amount_with_tax + description: The amount of the original price with taxes applied. + original_amount_without_tax: + type: number + title: original_amount_without_tax + description: The amount of the original price without taxes. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml index f5ad7d673d..17b199333b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml @@ -5,6 +5,7 @@ required: - id - order_id - order + - amount - reference - reference_id - metadata @@ -44,3 +45,7 @@ properties: format: date-time title: updated_at description: The date the credit line was updated. + amount: + type: number + title: amount + description: The credit line's amount. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml index e6fc76e22f..41fd512de0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml @@ -51,3 +51,7 @@ properties: format: date-time title: updated_at description: The date the item was updated. + damaged_quantity: + type: number + title: damaged_quantity + description: The item's damaged quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCalculatedPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCalculatedPrice.yaml index 295219e59e..625ca060bb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCalculatedPrice.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCalculatedPrice.yaml @@ -5,6 +5,8 @@ required: - id - calculated_amount - original_amount + - original_amount_with_tax + - original_amount_without_tax - currency_code properties: id: @@ -120,3 +122,11 @@ properties: type: number title: max_quantity description: The maximum quantity required in the cart for the price to apply. + original_amount_with_tax: + type: number + title: original_amount_with_tax + description: The original amount with taxes applied. + original_amount_without_tax: + type: number + title: original_amount_without_tax + description: The original amount without taxes. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 7b24f3cf51..e158901510 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -389,11 +389,11 @@ paths: operationId: PostActor_typeAuth_providerUpdate summary: Reset a Customer's Password x-sidebar-summary: Reset Password - description: Reset a customer's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword). + description: Reset a customer's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword). You pass the token as a bearer token in the request's Authorization header. externalDocs: url: https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#2-reset-password-page description: 'Storefront development: How to create the reset password page.' - x-authenticated: false + x-authenticated: true parameters: - name: auth_provider in: path @@ -402,12 +402,6 @@ paths: schema: type: string example: emailpass - - name: token - in: query - description: The reset password token received using the Get Reset Password API route. - required: true - schema: - type: string requestBody: content: application/json: @@ -422,12 +416,15 @@ paths: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/auth/customer/emailpass/update?token=123' \ + curl -X POST '{backend_url}/auth/customer/emailpass/update' \ -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer {token}' \ --data-raw '{ "email": "customer@gmail.com", "password": "supersecret" }' + security: + - reset_password: [] tags: - Auth responses: @@ -19595,6 +19592,8 @@ components: - id - calculated_amount - original_amount + - original_amount_with_tax + - original_amount_without_tax - currency_code properties: id: @@ -19644,6 +19643,14 @@ components: original_price: type: object description: The original price's details. + original_amount_with_tax: + type: number + title: original_amount_with_tax + description: The amount of the original price with taxes applied. + original_amount_without_tax: + type: number + title: original_amount_without_tax + description: The amount of the original price without taxes. BaseCapture: type: object description: The details of a captured payment. @@ -23938,6 +23945,7 @@ components: - id - order_id - order + - amount - reference - reference_id - metadata @@ -23975,6 +23983,10 @@ components: format: date-time title: updated_at description: The date the credit line was updated. + amount: + type: number + title: amount + description: The credit line's amount. OrderExchange: type: object description: The order change's exchange. @@ -24527,6 +24539,10 @@ components: format: date-time title: updated_at description: The date the item was updated. + damaged_quantity: + type: number + title: damaged_quantity + description: The item's damaged quantity. OrderShippingMethod: type: object description: The shipping method's details. @@ -25027,6 +25043,8 @@ components: - id - calculated_amount - original_amount + - original_amount_with_tax + - original_amount_without_tax - currency_code properties: id: @@ -25133,6 +25151,14 @@ components: type: number title: max_quantity description: The maximum quantity required in the cart for the price to apply. + original_amount_with_tax: + type: number + title: original_amount_with_tax + description: The original amount with taxes applied. + original_amount_without_tax: + type: number + title: original_amount_without_tax + description: The original amount without taxes. StoreCart: type: object description: The cart's details. @@ -34445,3 +34471,8 @@ components: x-displayName: Cookie Session ID in: cookie name: connect.sid + reset_password: + type: http + x-displayName: Reset Password Token + scheme: bearer + x-is-auth: false diff --git a/www/apps/api-reference/specs/store/openapi.yaml b/www/apps/api-reference/specs/store/openapi.yaml index 361843fbf8..6f59271631 100644 --- a/www/apps/api-reference/specs/store/openapi.yaml +++ b/www/apps/api-reference/specs/store/openapi.yaml @@ -302,3 +302,8 @@ components: x-displayName: Cookie Session ID in: cookie name: connect.sid + reset_password: + type: http + x-displayName: Reset Password Token + scheme: bearer + x-is-auth: false diff --git a/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_update.yaml b/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_update.yaml index 88bbd4cbf1..f6d4de22e6 100644 --- a/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_update.yaml +++ b/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_update.yaml @@ -6,11 +6,12 @@ post: Reset a customer's password using a reset-password token generated with the [Generate Reset Password Token API route](https://docs.medusajs.com/api/store#auth_postactor_typeauth_providerresetpassword). + You pass the token as a bearer token in the request's Authorization header. externalDocs: url: >- https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password#2-reset-password-page description: 'Storefront development: How to create the reset password page.' - x-authenticated: false + x-authenticated: true parameters: - name: auth_provider in: path @@ -19,14 +20,6 @@ post: schema: type: string example: emailpass - - name: token - in: query - description: >- - The reset password token received using the Get Reset Password API - route. - required: true - schema: - type: string requestBody: content: application/json: @@ -45,6 +38,8 @@ post: label: cURL source: $ref: ../code_samples/Shell/auth_customer_{auth_provider}_update/post.sh + security: + - reset_password: [] tags: - Auth responses: 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 8d3eb1accd..a366736891 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 @@ -922,48 +922,6 @@ * 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. - * enum: - * - canceled - * - not_fulfilled - * - partially_fulfilled - * - fulfilled - * - partially_shipped - * - shipped - * - partially_delivered - * - delivered - * - 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. - * enum: - * - canceled - * - not_paid - * - awaiting - * - authorized - * - partially_authorized - * - captured - * - partially_captured - * - partially_refunded - * - refunded - * - requires_action * - name: region_id * in: query * description: Filter by region IDs to retrieve their associated draft orders. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts index 87135964eb..b1835e7232 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts @@ -104,46 +104,6 @@ * type: string * title: sales_channel_id * description: A sales channel's ID. - * - name: fulfillment_status - * in: query - * description: Filter by the order's fulfillment status. - * required: false - * schema: - * type: array - * description: Filter by the order's fulfillment status. - * items: - * type: string - * description: A fulfillment status. - * enum: - * - canceled - * - not_fulfilled - * - partially_fulfilled - * - fulfilled - * - partially_shipped - * - shipped - * - partially_delivered - * - delivered - * - name: payment_status - * in: query - * description: Filter by the order's payment status. - * required: false - * schema: - * type: array - * description: Filter by the order's payment status. - * items: - * type: string - * description: A payment status - * enum: - * - canceled - * - not_paid - * - awaiting - * - authorized - * - partially_authorized - * - captured - * - partially_captured - * - partially_refunded - * - refunded - * - requires_action * - name: region_id * in: query * description: Filter by region IDs to retrieve their associated orders. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts index d86942519b..13c2887b02 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts @@ -104,46 +104,6 @@ * type: string * title: sales_channel_id * description: A sales channel's ID. - * - name: fulfillment_status - * in: query - * description: Filter by fulfillment statuses. - * required: false - * schema: - * type: array - * description: Filter by fulfillment statuses. - * items: - * type: string - * description: A fulfillment status. - * enum: - * - canceled - * - not_fulfilled - * - partially_fulfilled - * - fulfilled - * - partially_shipped - * - shipped - * - partially_delivered - * - delivered - * - name: payment_status - * in: query - * description: Filter by payment statuses. - * required: false - * schema: - * type: array - * description: Filter by payment statuses. - * items: - * type: string - * description: A payment status. - * enum: - * - canceled - * - not_paid - * - awaiting - * - authorized - * - partially_authorized - * - captured - * - partially_captured - * - partially_refunded - * - refunded - * - requires_action * - name: region_id * in: query * description: Filter by region IDs to retrieve their associated returns. diff --git a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts index ea2335d125..89f82949df 100644 --- a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts +++ b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts @@ -7,6 +7,8 @@ * - id * - calculated_amount * - original_amount + * - original_amount_with_tax + * - original_amount_without_tax * - currency_code * properties: * id: @@ -56,6 +58,14 @@ * original_price: * type: object * description: The original price's details. + * original_amount_with_tax: + * type: number + * title: original_amount_with_tax + * description: The amount of the original price with taxes applied. + * original_amount_without_tax: + * type: number + * title: original_amount_without_tax + * description: The amount of the original price without taxes. * */ diff --git a/www/utils/generated/oas-output/schemas/OrderCreditLine.ts b/www/utils/generated/oas-output/schemas/OrderCreditLine.ts index 40231139fe..b6ea13c7e1 100644 --- a/www/utils/generated/oas-output/schemas/OrderCreditLine.ts +++ b/www/utils/generated/oas-output/schemas/OrderCreditLine.ts @@ -7,6 +7,7 @@ * - id * - order_id * - order + * - amount * - reference * - reference_id * - metadata @@ -44,6 +45,10 @@ * format: date-time * title: updated_at * description: The date the credit line was updated. + * amount: + * type: number + * title: amount + * description: The credit line's amount. * */ diff --git a/www/utils/generated/oas-output/schemas/OrderReturnItem.ts b/www/utils/generated/oas-output/schemas/OrderReturnItem.ts index 8b14948b5b..14235657a9 100644 --- a/www/utils/generated/oas-output/schemas/OrderReturnItem.ts +++ b/www/utils/generated/oas-output/schemas/OrderReturnItem.ts @@ -51,6 +51,10 @@ * format: date-time * title: updated_at * description: The date the item was updated. + * damaged_quantity: + * type: number + * title: damaged_quantity + * description: The item's damaged quantity. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCalculatedPrice.ts b/www/utils/generated/oas-output/schemas/StoreCalculatedPrice.ts index 56e3305093..99cac12a95 100644 --- a/www/utils/generated/oas-output/schemas/StoreCalculatedPrice.ts +++ b/www/utils/generated/oas-output/schemas/StoreCalculatedPrice.ts @@ -7,6 +7,8 @@ * - id * - calculated_amount * - original_amount + * - original_amount_with_tax + * - original_amount_without_tax * - currency_code * properties: * id: @@ -113,6 +115,14 @@ * type: number * title: max_quantity * description: The maximum quantity required in the cart for the price to apply. + * original_amount_with_tax: + * type: number + * title: original_amount_with_tax + * description: The original amount with taxes applied. + * original_amount_without_tax: + * type: number + * title: original_amount_without_tax + * description: The original amount without taxes. * */