diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_convert-to-order/post.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_convert-to-order/post.js index 681f8498d7..9df4d979b7 100644 --- a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_convert-to-order/post.js +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_convert-to-order/post.js @@ -8,9 +8,6 @@ export const sdk = new Medusa({ }, }) -To convert a draft order to an order: - -```ts sdk.admin.draftOrder.convertToOrder("order_123") .then(({ order }) => { console.log(order) diff --git a/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/delete.js b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/delete.js new file mode 100644 index 0000000000..1b0a7dbea2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/delete.js @@ -0,0 +1,17 @@ +import Medusa from "@medusajs/js-sdk" + +export const sdk = new Medusa({ + baseUrl: import.meta.env.VITE_BACKEND_URL || "/", + debug: import.meta.env.DEV, + auth: { + type: "session", + }, +}) + +sdk.admin.draftOrder.removeShippingMethod( + "order_123", + "shipping_method_123" +) +.then(({ draft_order_preview }) => { + console.log(draft_order_preview) +}) \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/delete.sh new file mode 100644 index 0000000000..729a113438 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/draft-orders/{id}/edit/shipping-methods/method/{method_id}' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml index 6b780c9e0a..412778efd4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml @@ -27,17 +27,20 @@ properties: type: object description: The state of the step's invokation function. x-schemaName: WorkflowExecutionFn + required: + - state + - status properties: state: type: string description: The invokation step's state. enum: + - failed - not_started - invoking - compensating - done - reverted - - failed - dormant - skipped - skipped_failure @@ -51,9 +54,6 @@ properties: - waiting_response - temp_failure - permanent_failure - required: - - state - - status definition: type: object description: The step's definition details. @@ -75,8 +75,20 @@ properties: type: boolean title: continueOnPermanentFailure description: >- - Whether the step continues executing even if its status is - changed to failed. + Whether the workflow should continue executing even if its + status is changed to failed. + skipOnPermanentFailure: + oneOf: + - type: string + title: skipOnPermanentFailure + description: >- + The ID of the step to skip to in case of a permanent + failure. + - type: boolean + title: skipOnPermanentFailure + description: >- + Whether the workflow should skip subsequent steps in case of + a permanent failure. maxRetries: type: number title: maxRetries @@ -115,17 +127,20 @@ properties: type: object description: The state of the step's compensation function. x-schemaName: WorkflowExecutionFn + required: + - state + - status properties: state: type: string description: The compensation function's state. enum: + - failed - not_started - invoking - compensating - done - reverted - - failed - dormant - skipped - skipped_failure @@ -139,9 +154,6 @@ properties: - waiting_response - temp_failure - permanent_failure - required: - - state - - status depth: type: number title: depth diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index b084935017..7e7e4901ed 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -14711,9 +14711,6 @@ paths: }, }) - To convert a draft order to an order: - - ```ts sdk.admin.draftOrder.convertToOrder("order_123") .then(({ order }) => { console.log(order) @@ -15553,6 +15550,73 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: updateDraftOrderShippingMethodWorkflow + delete: + operationId: DeleteDraftOrdersIdEditShippingMethodsMethodMethod_id + summary: Remove Shipping Method from Draft Order + x-sidebar-summary: Remove Shipping Method + description: Remove the shipping method in a draft order that is being edited. + x-authenticated: true + parameters: + - name: id + in: path + description: The draft order's ID. + required: true + schema: + type: string + - name: method_id + in: path + description: The shipping method's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: |- + import Medusa from "@medusajs/js-sdk" + + export const sdk = new Medusa({ + baseUrl: import.meta.env.VITE_BACKEND_URL || "/", + debug: import.meta.env.DEV, + auth: { + type: "session", + }, + }) + + sdk.admin.draftOrder.removeShippingMethod( + "order_123", + "shipping_method_123" + ) + .then(({ draft_order_preview }) => { + console.log(draft_order_preview) + }) + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/draft-orders/{id}/edit/shipping-methods/method/{method_id}' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + x-workflow: removeDraftOrderShippingMethodWorkflow /admin/draft-orders/{id}/edit/shipping-methods/{action_id}: post: operationId: PostDraftOrdersIdEditShippingMethodsAction_id @@ -15634,8 +15698,8 @@ paths: x-workflow: updateDraftOrderActionShippingMethodWorkflow delete: operationId: DeleteDraftOrdersIdEditShippingMethodsAction_id - summary: Remove Shipping Method from Draft Order - x-sidebar-summary: Remove Shipping Method + summary: Remove New Shipping Method from Draft Order + x-sidebar-summary: Remove New Shipping Method description: | Remove the shipping method in a draft order using the `ID` of the method's `SHIPPING_ADD` action. @@ -63142,17 +63206,20 @@ components: type: object description: The state of the step's invokation function. x-schemaName: WorkflowExecutionFn + required: + - state + - status properties: state: type: string description: The invokation step's state. enum: + - failed - not_started - invoking - compensating - done - reverted - - failed - dormant - skipped - skipped_failure @@ -63166,9 +63233,6 @@ components: - waiting_response - temp_failure - permanent_failure - required: - - state - - status definition: type: object description: The step's definition details. @@ -63191,9 +63255,13 @@ components: title: continueOnPermanentFailure description: Whether the workflow should continue executing even if its status is changed to failed. skipOnPermanentFailure: - type: boolean - title: skipOnPermanentFailure - description: Whether the workflow should skip subsequent steps in case of a permanent failure. + oneOf: + - type: string + title: skipOnPermanentFailure + description: The ID of the step to skip to in case of a permanent failure. + - type: boolean + title: skipOnPermanentFailure + description: Whether the workflow should skip subsequent steps in case of a permanent failure. maxRetries: type: number title: maxRetries @@ -63223,17 +63291,20 @@ components: type: object description: The state of the step's compensation function. x-schemaName: WorkflowExecutionFn + required: + - state + - status properties: state: type: string description: The compensation function's state. enum: + - failed - not_started - invoking - compensating - done - reverted - - failed - dormant - skipped - skipped_failure @@ -63247,9 +63318,6 @@ components: - waiting_response - temp_failure - permanent_failure - required: - - state - - status depth: type: number title: depth diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}.yaml index 08199411d9..50da403edd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}.yaml @@ -55,3 +55,55 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: updateDraftOrderShippingMethodWorkflow +delete: + operationId: DeleteDraftOrdersIdEditShippingMethodsMethodMethod_id + summary: Remove Shipping Method from Draft Order + x-sidebar-summary: Remove Shipping Method + description: Remove the shipping method in a draft order that is being edited. + x-authenticated: true + parameters: + - name: id + in: path + description: The draft order's ID. + required: true + schema: + type: string + - name: method_id + in: path + description: The shipping method's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: JavaScript + label: JS SDK + source: + $ref: >- + ../code_samples/JavaScript/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/delete.js + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_draft-orders_{id}_edit_shipping-methods_method_{method_id}/delete.sh + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: removeDraftOrderShippingMethodWorkflow diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_{action_id}.yaml index 46b6582dc3..8e37842eaa 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}_edit_shipping-methods_{action_id}.yaml @@ -67,8 +67,8 @@ post: x-workflow: updateDraftOrderActionShippingMethodWorkflow delete: operationId: DeleteDraftOrdersIdEditShippingMethodsAction_id - summary: Remove Shipping Method from Draft Order - x-sidebar-summary: Remove Shipping Method + summary: Remove New Shipping Method from Draft Order + x-sidebar-summary: Remove New Shipping Method description: > Remove the shipping method in a draft order using the `ID` of the method's `SHIPPING_ADD` action. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml index 6b780c9e0a..412778efd4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml @@ -27,17 +27,20 @@ properties: type: object description: The state of the step's invokation function. x-schemaName: WorkflowExecutionFn + required: + - state + - status properties: state: type: string description: The invokation step's state. enum: + - failed - not_started - invoking - compensating - done - reverted - - failed - dormant - skipped - skipped_failure @@ -51,9 +54,6 @@ properties: - waiting_response - temp_failure - permanent_failure - required: - - state - - status definition: type: object description: The step's definition details. @@ -75,8 +75,20 @@ properties: type: boolean title: continueOnPermanentFailure description: >- - Whether the step continues executing even if its status is - changed to failed. + Whether the workflow should continue executing even if its + status is changed to failed. + skipOnPermanentFailure: + oneOf: + - type: string + title: skipOnPermanentFailure + description: >- + The ID of the step to skip to in case of a permanent + failure. + - type: boolean + title: skipOnPermanentFailure + description: >- + Whether the workflow should skip subsequent steps in case of + a permanent failure. maxRetries: type: number title: maxRetries @@ -115,17 +127,20 @@ properties: type: object description: The state of the step's compensation function. x-schemaName: WorkflowExecutionFn + required: + - state + - status properties: state: type: string description: The compensation function's state. enum: + - failed - not_started - invoking - compensating - done - reverted - - failed - dormant - skipped - skipped_failure @@ -139,9 +154,6 @@ properties: - waiting_response - temp_failure - permanent_failure - required: - - state - - status depth: type: number title: depth diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 27511aaae3..b1e807a16e 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -21288,17 +21288,20 @@ components: type: object description: The state of the step's invokation function. x-schemaName: WorkflowExecutionFn + required: + - state + - status properties: state: type: string description: The invokation step's state. enum: + - failed - not_started - invoking - compensating - done - reverted - - failed - dormant - skipped - skipped_failure @@ -21312,9 +21315,6 @@ components: - waiting_response - temp_failure - permanent_failure - required: - - state - - status definition: type: object description: The step's definition details. @@ -21337,9 +21337,13 @@ components: title: continueOnPermanentFailure description: Whether the workflow should continue executing even if its status is changed to failed. skipOnPermanentFailure: - type: boolean - title: skipOnPermanentFailure - description: Whether the workflow should skip subsequent steps in case of a permanent failure. + oneOf: + - type: string + title: skipOnPermanentFailure + description: The ID of the step to skip to in case of a permanent failure. + - type: boolean + title: skipOnPermanentFailure + description: Whether the workflow should skip subsequent steps in case of a permanent failure. maxRetries: type: number title: maxRetries @@ -21369,17 +21373,20 @@ components: type: object description: The state of the step's compensation function. x-schemaName: WorkflowExecutionFn + required: + - state + - status properties: state: type: string description: The compensation function's state. enum: + - failed - not_started - invoking - compensating - done - reverted - - failed - dormant - skipped - skipped_failure @@ -21393,9 +21400,6 @@ components: - waiting_response - temp_failure - permanent_failure - required: - - state - - status depth: type: number title: depth diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index 752df90a8c..722beaca2b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -20,15 +20,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts index 8cd294a91a..bd70b4fb30 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_[action_id].ts @@ -1,8 +1,8 @@ /** * @oas [delete] /admin/draft-orders/{id}/edit/shipping-methods/{action_id} * operationId: DeleteDraftOrdersIdEditShippingMethodsAction_id - * summary: Remove Shipping Method from Draft Order - * x-sidebar-summary: Remove Shipping Method + * summary: Remove New Shipping Method from Draft Order + * x-sidebar-summary: Remove New Shipping Method * description: | * Remove the shipping method in a draft order using the `ID` of the method's `SHIPPING_ADD` action. * diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts new file mode 100644 index 0000000000..ce3a4e5f43 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_draft-orders_[id]_edit_shipping-methods_method_[method_id].ts @@ -0,0 +1,71 @@ +/** + * @oas [delete] /admin/draft-orders/{id}/edit/shipping-methods/method/{method_id} + * operationId: DeleteDraftOrdersIdEditShippingMethodsMethodMethod_id + * summary: Remove Shipping Method from Draft Order + * x-sidebar-summary: Remove Shipping Method + * description: Remove the shipping method in a draft order that is being edited. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The draft order's ID. + * required: true + * schema: + * type: string + * - name: method_id + * in: path + * description: The shipping method's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: JavaScript + * label: JS SDK + * source: |- + * import Medusa from "@medusajs/js-sdk" + * + * export const sdk = new Medusa({ + * baseUrl: import.meta.env.VITE_BACKEND_URL || "/", + * debug: import.meta.env.DEV, + * auth: { + * type: "session", + * }, + * }) + * + * sdk.admin.draftOrder.removeShippingMethod( + * "order_123", + * "shipping_method_123" + * ) + * .then(({ draft_order_preview }) => { + * console.log(draft_order_preview) + * }) + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/draft-orders/{id}/edit/shipping-methods/method/{method_id}' \ + * -H 'Authorization: Bearer {access_token}' + * tags: + * - Draft Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * x-workflow: removeDraftOrderShippingMethodWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts index 88c792b326..4687bdf7ca 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts @@ -8,15 +8,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * - name: offset diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts index 053b324e60..18659fe153 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts @@ -14,15 +14,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index 1a737bbeee..95c7fc29b9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -14,15 +14,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * - name: offset diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts index 3e19b951a0..cd2ba58e7e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -20,15 +20,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index 33e09eb2e4..88b265fbad 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -8,15 +8,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * - name: offset diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts index 4d938d43c1..a9316cf526 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts @@ -14,15 +14,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * - name: include_ancestors_tree 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 127bee8943..31cd490a87 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 @@ -8,15 +8,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: 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 cb2fad6b40..db157864b2 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 @@ -14,15 +14,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: 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 f41f1a6319..4d9efa2f6a 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 @@ -15,15 +15,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: 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 7f4ce2901e..0d6cd20376 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 @@ -21,15 +21,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts index 8e7bfe5d91..b57fd14150 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts @@ -24,8 +24,8 @@ * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. Without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. Without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts index 77da39e592..dcc17bfdd6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders_[id]_convert-to-order.ts @@ -44,9 +44,6 @@ * }, * }) * - * To convert a draft order to an order: - * - * ```ts * sdk.admin.draftOrder.convertToOrder("order_123") * .then(({ order }) => { * console.log(order) diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts index 5d001ece05..719a78114a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts @@ -8,15 +8,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts index 8a9335f0b9..949c1b34c2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts @@ -14,15 +14,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts index a0d69fe3f6..cb4cb98d21 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts @@ -15,15 +15,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts index 634d8c234c..04652c25ce 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts @@ -26,15 +26,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts index a04bc6ccf4..a9749c4b92 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts @@ -20,15 +20,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts index 10cda02f97..80597ac3dc 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -20,15 +20,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * - name: offset diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts index a2ec26c7bf..d24f926bf8 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts @@ -23,15 +23,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers.ts b/www/utils/generated/oas-output/operations/store/post_store_customers.ts index e918c2793a..f449c1cb8a 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers.ts @@ -25,8 +25,8 @@ * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * requestBody: diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts index ab7df7ce21..048aef046e 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts @@ -25,8 +25,8 @@ * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts index 97f89dd94d..af5ae1e3f3 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -20,15 +20,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts index 99c02f9270..9d1e780431 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -26,15 +26,15 @@ * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * required: false * schema: * type: string * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in - * the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. + * fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom + * Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation. * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts b/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts index f41a108ae8..efaa1331e3 100644 --- a/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts +++ b/www/utils/generated/oas-output/schemas/AdminWorkflowExecutionExecution.ts @@ -27,17 +27,20 @@ * type: object * description: The state of the step's invokation function. * x-schemaName: WorkflowExecutionFn + * required: + * - state + * - status * properties: * state: * type: string * description: The invokation step's state. * enum: + * - failed * - not_started * - invoking * - compensating * - done * - reverted - * - failed * - dormant * - skipped * - skipped_failure @@ -51,9 +54,6 @@ * - waiting_response * - temp_failure * - permanent_failure - * required: - * - state - * - status * definition: * type: object * description: The step's definition details. @@ -76,9 +76,13 @@ * title: continueOnPermanentFailure * description: Whether the workflow should continue executing even if its status is changed to failed. * skipOnPermanentFailure: - * type: boolean - * title: skipOnPermanentFailure - * description: Whether the workflow should skip subsequent steps in case of a permanent failure. + * oneOf: + * - type: string + * title: skipOnPermanentFailure + * description: The ID of the step to skip to in case of a permanent failure. + * - type: boolean + * title: skipOnPermanentFailure + * description: Whether the workflow should skip subsequent steps in case of a permanent failure. * maxRetries: * type: number * title: maxRetries @@ -108,17 +112,20 @@ * type: object * description: The state of the step's compensation function. * x-schemaName: WorkflowExecutionFn + * required: + * - state + * - status * properties: * state: * type: string * description: The compensation function's state. * enum: + * - failed * - not_started * - invoking * - compensating * - done * - reverted - * - failed * - dormant * - skipped * - skipped_failure @@ -132,9 +139,6 @@ * - waiting_response * - temp_failure * - permanent_failure - * required: - * - state - * - status * depth: * type: number * title: depth diff --git a/www/utils/generated/route-examples-output/route-examples.json b/www/utils/generated/route-examples-output/route-examples.json index 1c646161dd..edfc6c28b2 100644 --- a/www/utils/generated/route-examples-output/route-examples.json +++ b/www/utils/generated/route-examples-output/route-examples.json @@ -171,7 +171,7 @@ "js-sdk": "sdk.admin.draftOrder.update(\"order_123\", {\n email: \"test@test.com\",\n})\n.then(({ draft_order }) => {\n console.log(draft_order)\n})" }, "POST /admin/draft-orders/{id}/convert-to-order": { - "js-sdk": "To convert a draft order to an order:\n\n```ts\nsdk.admin.draftOrder.convertToOrder(\"order_123\")\n.then(({ order }) => {\n console.log(order)\n})" + "js-sdk": "sdk.admin.draftOrder.convertToOrder(\"order_123\")\n.then(({ order }) => {\n console.log(order)\n})" }, "POST /admin/draft-orders/{id}/edit/items": { "js-sdk": "sdk.admin.draftOrder.addItems(\"order_123\", {\n items: [\n {\n variant_id: \"variant_123\",\n quantity: 1,\n },\n ],\n})\n.then(({ draft_order_preview }) => {\n console.log(draft_order_preview)\n})" @@ -330,7 +330,7 @@ "js-sdk": "sdk.admin.inventoryItem.batchInventoryItemsLocationLevels({\n create: [{\n inventory_item_id: \"iitem_123\",\n location_id: \"sloc_123\",\n stocked_quantity: 10\n }],\n delete: [\"ilvl_123\"]\n})\n.then(({ created, updated, deleted }) => {\n console.log(created, updated, deleted)\n})" }, "POST /admin/invites/accept": { - "js-sdk": "const token = await sdk.auth.register(\"user\", \"emailpass\", {\n email: \"user@gmail.com\",\n password: \"supersecret\"\n})\n\nsdk.admin.invite.accept(\n {\n email: \"user@gmail.com\",\n first_name: \"John\",\n last_name: \"Smith\",\n invite_token: \"12345...\"\n },\n {\n Authorization: `Bearer ${token}`\n }\n)\n.then(({ user }) => {\n console.log(user)\n})" + "js-sdk": "await sdk.auth.register(\"user\", \"emailpass\", {\n email: \"user@gmail.com\",\n password: \"supersecret\"\n})\n\n// all subsequent requests will use the token in the header\nconst { user } = await sdk.admin.invite.accept(\n {\n email: \"user@gmail.com\",\n first_name: \"John\",\n last_name: \"Smith\",\n invite_token: \"12345...\"\n },\n)" }, "POST /admin/invites": { "js-sdk": "sdk.admin.invite.create({\n email: \"user@gmail.com\",\n})\n.then(({ invite }) => {\n console.log(invite)\n})"