From 198fa5312025a16542cd9723a016e2503b467763 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 23 Dec 2024 08:35:12 +0000 Subject: [PATCH] chore(docs): Updated API Reference (automated) (#10685) 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> --- .../redocly/redocly-config.yaml | 2 + .../get.sh | 2 + .../AdminFulfillmentProviderOption.yaml | 15 ++ ...ulfillmentProviderOptionsListResponse.yaml | 26 ++++ .../specs/admin/components/schemas/Order.yaml | 7 + .../components/schemas/OrderCreditLine.yaml | 46 ++++++ .../specs/admin/openapi.full.yaml | 137 ++++++++++++++++++ .../api-reference/specs/admin/openapi.yaml | 2 + ...in_fulfillment-providers_{id}_options.yaml | 45 ++++++ .../AdminFulfillmentProviderOption.yaml | 15 ++ ...ulfillmentProviderOptionsListResponse.yaml | 26 ++++ .../specs/store/components/schemas/Order.yaml | 7 + .../components/schemas/OrderCreditLine.yaml | 46 ++++++ .../specs/store/openapi.full.yaml | 93 ++++++++++++ ...dmin_fulfillment-providers_[id]_options.ts | 47 ++++++ .../schemas/AdminFulfillmentProviderOption.ts | 20 +++ ...nFulfillmentProviderOptionsListResponse.ts | 31 ++++ .../generated/oas-output/schemas/Order.ts | 5 + .../oas-output/schemas/OrderCreditLine.ts | 49 +++++++ 19 files changed, 621 insertions(+) create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers_{id}_options/get.sh create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOption.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers_{id}_options.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOption.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers_[id]_options.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFulfillmentProviderOption.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminFulfillmentProviderOptionsListResponse.ts create mode 100644 www/utils/generated/oas-output/schemas/OrderCreditLine.ts diff --git a/packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml b/packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml index 9a8af4001ee54..4a34a21ca44a2 100644 --- a/packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml +++ b/packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml @@ -137,6 +137,8 @@ decorators: - AdminProduct Return: - OrderExchange + OrderCreditLine: + - Order theme: openapi: theme: diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers_{id}_options/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers_{id}_options/get.sh new file mode 100644 index 0000000000000..70ead0de6fa2c --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers_{id}_options/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/fulfillment-providers/{id}/options' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOption.yaml new file mode 100644 index 0000000000000..1a7c7a476af43 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOption.yaml @@ -0,0 +1,15 @@ +type: object +description: The fulfillment option's details. +x-schemaName: AdminFulfillmentProviderOption +required: + - id + - is_return +properties: + id: + type: string + title: id + description: The fulfillment option's ID. + is_return: + type: boolean + title: is_return + description: Whether the fulfillment option is used for returns. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml new file mode 100644 index 0000000000000..dce367d1babb3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: The paginated list of fulfillment options. +x-schemaName: AdminFulfillmentProviderOptionsListResponse +required: + - limit + - offset + - count + - fulfillment_options +properties: + limit: + type: number + title: limit + description: The maximum number of items returned. + offset: + type: number + title: offset + description: The number of items skipped before retrieving the returned items. + count: + type: number + title: count + description: The total number of items. + fulfillment_options: + type: array + description: The list of fulfillment options. + items: + $ref: ./AdminFulfillmentProviderOption.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml index f750856087aeb..fbb4d9bc32145 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -211,3 +211,10 @@ properties: type: number title: display_id description: The order's display ID. + credit_lines: + type: array + description: >- + The order's credit lines, useful to add additional payment amounts for an + order. + items: + $ref: ./OrderCreditLine.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml new file mode 100644 index 0000000000000..f5ad7d673ddbb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderCreditLine.yaml @@ -0,0 +1,46 @@ +type: object +description: The credit line's details. +x-schemaName: OrderCreditLine +required: + - id + - order_id + - order + - reference + - reference_id + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The credit line's ID. + order_id: + type: string + title: order_id + description: The ID of the associated order. + order: + type: object + reference: + type: string + title: reference + description: >- + The table that this credit line references. For example, + `payment_collection`. + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. For example, `paycol_123`. + metadata: + type: object + description: The credit line's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the credit line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the credit line was updated. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index a57b3f98180a8..96ba4a96838f7 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -15374,6 +15374,50 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/fulfillment-providers/{id}/options: + get: + operationId: GetFulfillmentProvidersIdOptions + summary: List Fulfillment Options + description: Retrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment provider's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/fulfillment-providers/{id}/options' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Fulfillment Providers + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFulfillmentProviderOptionsListResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/fulfillment-sets/{id}: delete: operationId: DeleteFulfillmentSetsId @@ -47310,6 +47354,49 @@ components: description: The list of fulfillment providers. items: $ref: '#/components/schemas/AdminFulfillmentProvider' + AdminFulfillmentProviderOption: + type: object + description: The fulfillment option's details. + x-schemaName: AdminFulfillmentProviderOption + required: + - id + - is_return + properties: + id: + type: string + title: id + description: The fulfillment option's ID. + is_return: + type: boolean + title: is_return + description: Whether the fulfillment option is used for returns. + AdminFulfillmentProviderOptionsListResponse: + type: object + description: The paginated list of fulfillment options. + x-schemaName: AdminFulfillmentProviderOptionsListResponse + required: + - limit + - offset + - count + - fulfillment_options + properties: + limit: + type: number + title: limit + description: The maximum number of items returned. + offset: + type: number + title: offset + description: The number of items skipped before retrieving the returned items. + count: + type: number + title: count + description: The total number of items. + fulfillment_options: + type: array + description: The list of fulfillment options. + items: + $ref: '#/components/schemas/AdminFulfillmentProviderOption' AdminFulfillmentResponse: type: object description: A fulfillment's details. @@ -58909,6 +58996,11 @@ components: type: number title: display_id description: The order's display ID. + credit_lines: + type: array + description: The order's credit lines, useful to add additional payment amounts for an order. + items: + $ref: '#/components/schemas/OrderCreditLine' OrderAddress: type: object description: The address's details. @@ -59334,6 +59426,51 @@ components: title: canceled_at description: The date the claim was canceled. format: date-time + OrderCreditLine: + type: object + description: The credit line's details. + x-schemaName: OrderCreditLine + required: + - id + - order_id + - order + - reference + - reference_id + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The credit line's ID. + order_id: + type: string + title: order_id + description: The ID of the associated order. + order: + type: object + reference: + type: string + title: reference + description: The table that this credit line references. For example, `payment_collection`. + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. For example, `paycol_123`. + metadata: + type: object + description: The credit line's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the credit line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the credit line was updated. OrderExchange: type: object description: The order change's exchange. diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index e31e84806da8b..73158d3e05871 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -725,6 +725,8 @@ paths: $ref: paths/admin_exchanges_{id}_request.yaml /admin/fulfillment-providers: $ref: paths/admin_fulfillment-providers.yaml + /admin/fulfillment-providers/{id}/options: + $ref: paths/admin_fulfillment-providers_{id}_options.yaml /admin/fulfillment-sets/{id}: $ref: paths/admin_fulfillment-sets_{id}.yaml /admin/fulfillment-sets/{id}/service-zones: diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers_{id}_options.yaml new file mode 100644 index 0000000000000..32ce5b4b155c9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers_{id}_options.yaml @@ -0,0 +1,45 @@ +get: + operationId: GetFulfillmentProvidersIdOptions + summary: List Fulfillment Options + description: >- + Retrieve the list of fulfillment options of a fulfillment provider. These + options may be retrieved from an integrated third-party service. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment provider's ID. + required: true + schema: + type: string + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_fulfillment-providers_{id}_options/get.sh + tags: + - Fulfillment Providers + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOption.yaml new file mode 100644 index 0000000000000..1a7c7a476af43 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOption.yaml @@ -0,0 +1,15 @@ +type: object +description: The fulfillment option's details. +x-schemaName: AdminFulfillmentProviderOption +required: + - id + - is_return +properties: + id: + type: string + title: id + description: The fulfillment option's ID. + is_return: + type: boolean + title: is_return + description: Whether the fulfillment option is used for returns. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml new file mode 100644 index 0000000000000..dce367d1babb3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProviderOptionsListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: The paginated list of fulfillment options. +x-schemaName: AdminFulfillmentProviderOptionsListResponse +required: + - limit + - offset + - count + - fulfillment_options +properties: + limit: + type: number + title: limit + description: The maximum number of items returned. + offset: + type: number + title: offset + description: The number of items skipped before retrieving the returned items. + count: + type: number + title: count + description: The total number of items. + fulfillment_options: + type: array + description: The list of fulfillment options. + items: + $ref: ./AdminFulfillmentProviderOption.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml index f750856087aeb..fbb4d9bc32145 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -211,3 +211,10 @@ properties: type: number title: display_id description: The order's display ID. + credit_lines: + type: array + description: >- + The order's credit lines, useful to add additional payment amounts for an + order. + items: + $ref: ./OrderCreditLine.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml new file mode 100644 index 0000000000000..f5ad7d673ddbb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderCreditLine.yaml @@ -0,0 +1,46 @@ +type: object +description: The credit line's details. +x-schemaName: OrderCreditLine +required: + - id + - order_id + - order + - reference + - reference_id + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The credit line's ID. + order_id: + type: string + title: order_id + description: The ID of the associated order. + order: + type: object + reference: + type: string + title: reference + description: >- + The table that this credit line references. For example, + `payment_collection`. + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. For example, `paycol_123`. + metadata: + type: object + description: The credit line's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the credit line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the credit line was updated. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 00585c2bf7431..092ba58c2770c 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -9584,6 +9584,49 @@ components: description: The list of fulfillment providers. items: $ref: '#/components/schemas/AdminFulfillmentProvider' + AdminFulfillmentProviderOption: + type: object + description: The fulfillment option's details. + x-schemaName: AdminFulfillmentProviderOption + required: + - id + - is_return + properties: + id: + type: string + title: id + description: The fulfillment option's ID. + is_return: + type: boolean + title: is_return + description: Whether the fulfillment option is used for returns. + AdminFulfillmentProviderOptionsListResponse: + type: object + description: The paginated list of fulfillment options. + x-schemaName: AdminFulfillmentProviderOptionsListResponse + required: + - limit + - offset + - count + - fulfillment_options + properties: + limit: + type: number + title: limit + description: The maximum number of items returned. + offset: + type: number + title: offset + description: The number of items skipped before retrieving the returned items. + count: + type: number + title: count + description: The total number of items. + fulfillment_options: + type: array + description: The list of fulfillment options. + items: + $ref: '#/components/schemas/AdminFulfillmentProviderOption' AdminFulfillmentResponse: type: object description: A fulfillment's details. @@ -21183,6 +21226,11 @@ components: type: number title: display_id description: The order's display ID. + credit_lines: + type: array + description: The order's credit lines, useful to add additional payment amounts for an order. + items: + $ref: '#/components/schemas/OrderCreditLine' OrderAddress: type: object description: The address's details. @@ -21608,6 +21656,51 @@ components: title: canceled_at description: The date the claim was canceled. format: date-time + OrderCreditLine: + type: object + description: The credit line's details. + x-schemaName: OrderCreditLine + required: + - id + - order_id + - order + - reference + - reference_id + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The credit line's ID. + order_id: + type: string + title: order_id + description: The ID of the associated order. + order: + type: object + reference: + type: string + title: reference + description: The table that this credit line references. For example, `payment_collection`. + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. For example, `paycol_123`. + metadata: + type: object + description: The credit line's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the credit line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the credit line was updated. OrderExchange: type: object description: The order change's exchange. diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers_[id]_options.ts new file mode 100644 index 0000000000000..0c24dc27828f4 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers_[id]_options.ts @@ -0,0 +1,47 @@ +/** + * @oas [get] /admin/fulfillment-providers/{id}/options + * operationId: GetFulfillmentProvidersIdOptions + * summary: List Fulfillment Options + * description: Retrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The fulfillment provider's ID. + * required: true + * schema: + * type: string + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/fulfillment-providers/{id}/options' \ + * -H 'Authorization: Bearer {access_token}' + * tags: + * - Fulfillment Providers + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminFulfillmentProviderOptionsListResponse" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderOption.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderOption.ts new file mode 100644 index 0000000000000..f17341a4cfef3 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderOption.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminFulfillmentProviderOption + * type: object + * description: The fulfillment option's details. + * x-schemaName: AdminFulfillmentProviderOption + * required: + * - id + * - is_return + * properties: + * id: + * type: string + * title: id + * description: The fulfillment option's ID. + * is_return: + * type: boolean + * title: is_return + * description: Whether the fulfillment option is used for returns. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderOptionsListResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderOptionsListResponse.ts new file mode 100644 index 0000000000000..beaf439abc8b2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderOptionsListResponse.ts @@ -0,0 +1,31 @@ +/** + * @schema AdminFulfillmentProviderOptionsListResponse + * type: object + * description: The paginated list of fulfillment options. + * x-schemaName: AdminFulfillmentProviderOptionsListResponse + * required: + * - limit + * - offset + * - count + * - fulfillment_options + * properties: + * limit: + * type: number + * title: limit + * description: The maximum number of items returned. + * offset: + * type: number + * title: offset + * description: The number of items skipped before retrieving the returned items. + * count: + * type: number + * title: count + * description: The total number of items. + * fulfillment_options: + * type: array + * description: The list of fulfillment options. + * items: + * $ref: "#/components/schemas/AdminFulfillmentProviderOption" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts index ae67e435a0c27..e7987dd3403d5 100644 --- a/www/utils/generated/oas-output/schemas/Order.ts +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -213,6 +213,11 @@ * type: number * title: display_id * description: The order's display ID. + * credit_lines: + * type: array + * description: The order's credit lines, useful to add additional payment amounts for an order. + * items: + * $ref: "#/components/schemas/OrderCreditLine" * */ diff --git a/www/utils/generated/oas-output/schemas/OrderCreditLine.ts b/www/utils/generated/oas-output/schemas/OrderCreditLine.ts new file mode 100644 index 0000000000000..40231139fec9f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/OrderCreditLine.ts @@ -0,0 +1,49 @@ +/** + * @schema OrderCreditLine + * type: object + * description: The credit line's details. + * x-schemaName: OrderCreditLine + * required: + * - id + * - order_id + * - order + * - reference + * - reference_id + * - metadata + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The credit line's ID. + * order_id: + * type: string + * title: order_id + * description: The ID of the associated order. + * order: + * $ref: "#/components/schemas/Order" + * reference: + * type: string + * title: reference + * description: The table that this credit line references. For example, `payment_collection`. + * reference_id: + * type: string + * title: reference_id + * description: The ID of the record in the referenced table. For example, `paycol_123`. + * metadata: + * type: object + * description: The credit line's metadata, can hold custom key-value pairs. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the credit line was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the credit line was updated. + * +*/ +