From 82fd93da17d4e365827f86fa55ff6abec5dc14b0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 11 Nov 2024 12:30:22 +0000 Subject: [PATCH] chore(docs): Updated API Reference (automated) (#10017) 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> --- .../schemas/AdminOrderLineItem.yaml | 2 +- .../components/schemas/BaseOrderLineItem.yaml | 2 +- .../specs/admin/components/schemas/Order.yaml | 2 +- .../components/schemas/OrderExchange.yaml | 15 +----- .../components/schemas/OrderLineItem.yaml | 2 +- .../admin/components/schemas/Return.yaml | 15 +----- .../schemas/StoreOrderLineItem.yaml | 2 +- .../schemas/StoreUpdateCustomer.yaml | 2 +- .../specs/admin/openapi.full.yaml | 46 +++++-------------- .../admin_customers_{id}_customer-groups.yaml | 9 ++-- .../schemas/AdminOrderLineItem.yaml | 2 +- .../components/schemas/BaseOrderLineItem.yaml | 2 +- .../specs/store/components/schemas/Order.yaml | 2 +- .../components/schemas/OrderExchange.yaml | 15 +----- .../components/schemas/OrderLineItem.yaml | 2 +- .../store/components/schemas/Return.yaml | 15 +----- .../schemas/StoreOrderLineItem.yaml | 2 +- .../schemas/StoreUpdateCustomer.yaml | 2 +- .../specs/store/openapi.full.yaml | 42 ++++------------- ...st_admin_customers_[id]_customer-groups.ts | 4 +- .../oas-output/schemas/AdminOrderLineItem.ts | 2 +- .../oas-output/schemas/BaseOrderLineItem.ts | 2 +- .../generated/oas-output/schemas/Order.ts | 2 +- .../oas-output/schemas/OrderExchange.ts | 15 +----- .../oas-output/schemas/OrderLineItem.ts | 2 +- .../generated/oas-output/schemas/Return.ts | 15 +----- .../oas-output/schemas/StoreOrderLineItem.ts | 2 +- .../oas-output/schemas/StoreUpdateCustomer.ts | 2 +- 28 files changed, 60 insertions(+), 167 deletions(-) diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml index 7db7d00725fcc..a6b3ba9b68fbb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml @@ -215,4 +215,4 @@ properties: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml index f9e313dbdbfc4..115a58c2dbe82 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml @@ -215,4 +215,4 @@ properties: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. 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 0d7240355e738..f750856087aeb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -210,4 +210,4 @@ properties: display_id: type: number title: display_id - description: The order's display id. + description: The order's display ID. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml index f248767bb4db8..857b9ed634090 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml @@ -23,19 +23,8 @@ properties: title: no_notification description: Whether to send the customer notifications when the exchange is updated. difference_due: - oneOf: - - type: string - title: difference_due - description: The exchange's difference due. - - type: number - title: difference_due - description: The exchange's difference due. - - type: string - title: difference_due - description: The exchange's difference due. - - type: number - title: difference_due - description: The exchange's difference due. + type: number + title: difference_due description: >- The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml index 7e36d6dfb2b12..1c7d68676010e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml @@ -197,4 +197,4 @@ properties: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. diff --git a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml index 2f8d70244f7db..cfefdef18c517 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml @@ -22,19 +22,8 @@ properties: - received - partially_received refund_amount: - oneOf: - - type: string - title: refund_amount - description: The return order's refund amount. - - type: number - title: refund_amount - description: The return order's refund amount. - - type: string - title: refund_amount - description: The return order's refund amount. - - type: number - title: refund_amount - description: The return order's refund amount. + type: number + title: refund_amount description: The amount refunded by this return. order_id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml index 08344ea2e8359..556ab17106765 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml @@ -4013,4 +4013,4 @@ properties: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml index 0384a1809c13d..700e28826a85e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml @@ -20,4 +20,4 @@ properties: description: The customer's phone. metadata: type: object - description: The customer's metadata. + description: The customer's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 09d68eae80550..cace33e139412 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -11441,8 +11441,8 @@ paths: 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. + 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. required: false schema: type: string @@ -48352,7 +48352,7 @@ components: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. AdminOrderPreview: type: object description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it. @@ -55950,7 +55950,7 @@ components: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. BaseOrderLineItemAdjustment: type: object description: The adjustment's details. @@ -58344,7 +58344,7 @@ components: display_id: type: number title: display_id - description: The order's display id. + description: The order's display ID. OrderAddress: type: object description: The address's details. @@ -58807,19 +58807,8 @@ components: title: no_notification description: Whether to send the customer notifications when the exchange is updated. difference_due: - oneOf: - - type: string - title: difference_due - description: The exchange's difference due. - - type: number - title: difference_due - description: The exchange's difference due. - - type: string - title: difference_due - description: The exchange's difference due. - - type: number - title: difference_due - description: The exchange's difference due. + type: number + title: difference_due description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer. return: $ref: '#/components/schemas/Return' @@ -59171,7 +59160,7 @@ components: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. OrderLineItemAdjustment: type: object description: The line item adjustment's details. @@ -59702,19 +59691,8 @@ components: - received - partially_received refund_amount: - oneOf: - - type: string - title: refund_amount - description: The return order's refund amount. - - type: number - title: refund_amount - description: The return order's refund amount. - - type: string - title: refund_amount - description: The return order's refund amount. - - type: number - title: refund_amount - description: The return order's refund amount. + type: number + title: refund_amount description: The amount refunded by this return. order_id: type: string @@ -65691,7 +65669,7 @@ components: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. StoreOrderResponse: type: object description: The order's details. @@ -68561,7 +68539,7 @@ components: description: The customer's phone. metadata: type: object - description: The customer's metadata. + description: The customer's metadata, can hold custom key-value pairs. UpdateAddress: type: object description: The details to update in the address. diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml index 29ebfd3fba279..6e0fef0e9fb09 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml @@ -12,10 +12,13 @@ post: type: string - name: fields in: query - description: |- + 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. + + 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. required: false schema: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml index 7db7d00725fcc..a6b3ba9b68fbb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml @@ -215,4 +215,4 @@ properties: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml index f9e313dbdbfc4..115a58c2dbe82 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml @@ -215,4 +215,4 @@ properties: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. 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 0d7240355e738..f750856087aeb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -210,4 +210,4 @@ properties: display_id: type: number title: display_id - description: The order's display id. + description: The order's display ID. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml index f248767bb4db8..857b9ed634090 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml @@ -23,19 +23,8 @@ properties: title: no_notification description: Whether to send the customer notifications when the exchange is updated. difference_due: - oneOf: - - type: string - title: difference_due - description: The exchange's difference due. - - type: number - title: difference_due - description: The exchange's difference due. - - type: string - title: difference_due - description: The exchange's difference due. - - type: number - title: difference_due - description: The exchange's difference due. + type: number + title: difference_due description: >- The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml index 7e36d6dfb2b12..1c7d68676010e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml @@ -197,4 +197,4 @@ properties: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. diff --git a/www/apps/api-reference/specs/store/components/schemas/Return.yaml b/www/apps/api-reference/specs/store/components/schemas/Return.yaml index 07c01f09432fb..2460eadd117cb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Return.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Return.yaml @@ -22,19 +22,8 @@ properties: - received - partially_received refund_amount: - oneOf: - - type: string - title: refund_amount - description: The return order's refund amount. - - type: number - title: refund_amount - description: The return order's refund amount. - - type: string - title: refund_amount - description: The return order's refund amount. - - type: number - title: refund_amount - description: The return order's refund amount. + type: number + title: refund_amount description: The amount refunded by this return. order_id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml index 08344ea2e8359..556ab17106765 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml @@ -4013,4 +4013,4 @@ properties: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml index 0384a1809c13d..700e28826a85e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml @@ -20,4 +20,4 @@ properties: description: The customer's phone. metadata: type: object - description: The customer's metadata. + description: The customer's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 1717435251074..937bfe0141b0d 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -10382,7 +10382,7 @@ components: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. AdminOrderPreview: type: object description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it. @@ -17980,7 +17980,7 @@ components: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. BaseOrderLineItemAdjustment: type: object description: The adjustment's details. @@ -20374,7 +20374,7 @@ components: display_id: type: number title: display_id - description: The order's display id. + description: The order's display ID. OrderAddress: type: object description: The address's details. @@ -20837,19 +20837,8 @@ components: title: no_notification description: Whether to send the customer notifications when the exchange is updated. difference_due: - oneOf: - - type: string - title: difference_due - description: The exchange's difference due. - - type: number - title: difference_due - description: The exchange's difference due. - - type: string - title: difference_due - description: The exchange's difference due. - - type: number - title: difference_due - description: The exchange's difference due. + type: number + title: difference_due description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer. return: $ref: '#/components/schemas/Return' @@ -21201,7 +21190,7 @@ components: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. OrderLineItemAdjustment: type: object description: The line item adjustment's details. @@ -21732,19 +21721,8 @@ components: - received - partially_received refund_amount: - oneOf: - - type: string - title: refund_amount - description: The return order's refund amount. - - type: number - title: refund_amount - description: The return order's refund amount. - - type: string - title: refund_amount - description: The return order's refund amount. - - type: number - title: refund_amount - description: The return order's refund amount. + type: number + title: refund_amount description: The amount refunded by this return. order_id: type: string @@ -27721,7 +27699,7 @@ components: product_type_id: type: string title: product_type_id - description: The item's product type id. + description: The ID of the associated product's type. StoreOrderResponse: type: object description: The order's details. @@ -30591,7 +30569,7 @@ components: description: The customer's phone. metadata: type: object - description: The customer's metadata. + description: The customer's metadata, can hold custom key-value pairs. UpdateAddress: type: object description: The details to update in the address. 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 73c8a3290c7a4..2bb2e28547672 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 @@ -15,8 +15,8 @@ * 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. + * 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. * required: false * schema: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts b/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts index adcb52e2413ac..2a59ebb67e8c0 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts @@ -217,7 +217,7 @@ * product_type_id: * type: string * title: product_type_id - * description: The item's product type id. + * description: The ID of the associated product's type. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts index ec6c5ec9a1716..9b9ef95f4aece 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts @@ -217,7 +217,7 @@ * product_type_id: * type: string * title: product_type_id - * description: The item's product type id. + * description: The ID of the associated product's type. * */ diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts index 6b1c6fe6e3d20..ae67e435a0c27 100644 --- a/www/utils/generated/oas-output/schemas/Order.ts +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -212,7 +212,7 @@ * display_id: * type: number * title: display_id - * description: The order's display id. + * description: The order's display ID. * */ diff --git a/www/utils/generated/oas-output/schemas/OrderExchange.ts b/www/utils/generated/oas-output/schemas/OrderExchange.ts index c254d2e817634..a1b7f92eb6d9f 100644 --- a/www/utils/generated/oas-output/schemas/OrderExchange.ts +++ b/www/utils/generated/oas-output/schemas/OrderExchange.ts @@ -25,19 +25,8 @@ * title: no_notification * description: Whether to send the customer notifications when the exchange is updated. * difference_due: - * oneOf: - * - type: string - * title: difference_due - * description: The exchange's difference due. - * - type: number - * title: difference_due - * description: The exchange's difference due. - * - type: string - * title: difference_due - * description: The exchange's difference due. - * - type: number - * title: difference_due - * description: The exchange's difference due. + * type: number + * title: difference_due * description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer. * return: * $ref: "#/components/schemas/Return" diff --git a/www/utils/generated/oas-output/schemas/OrderLineItem.ts b/www/utils/generated/oas-output/schemas/OrderLineItem.ts index 317af770e75cc..23b8d6a46a0ec 100644 --- a/www/utils/generated/oas-output/schemas/OrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/OrderLineItem.ts @@ -197,7 +197,7 @@ * product_type_id: * type: string * title: product_type_id - * description: The item's product type id. + * description: The ID of the associated product's type. * */ diff --git a/www/utils/generated/oas-output/schemas/Return.ts b/www/utils/generated/oas-output/schemas/Return.ts index 12bfa984105a3..b4d003ec8de7b 100644 --- a/www/utils/generated/oas-output/schemas/Return.ts +++ b/www/utils/generated/oas-output/schemas/Return.ts @@ -24,19 +24,8 @@ * - received * - partially_received * refund_amount: - * oneOf: - * - type: string - * title: refund_amount - * description: The return order's refund amount. - * - type: number - * title: refund_amount - * description: The return order's refund amount. - * - type: string - * title: refund_amount - * description: The return order's refund amount. - * - type: number - * title: refund_amount - * description: The return order's refund amount. + * type: number + * title: refund_amount * description: The amount refunded by this return. * order_id: * type: string diff --git a/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts b/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts index ae05472d93bef..4cbe756553a16 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts @@ -4015,7 +4015,7 @@ * product_type_id: * type: string * title: product_type_id - * description: The item's product type id. + * description: The ID of the associated product's type. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts b/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts index 0a288a8f765ba..90f0b31d5d913 100644 --- a/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts +++ b/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts @@ -22,7 +22,7 @@ * description: The customer's phone. * metadata: * type: object - * description: The customer's metadata. + * description: The customer's metadata, can hold custom key-value pairs. * */