import type * as Square from "../../../../index"; /** * @example * { * customerId: "customer_id", * emailAddress: "New.Amelia.Earhart@example.com", * note: "updated customer note", * version: BigInt("2") * } */ export interface UpdateCustomerRequest { /** The ID of the customer to update. */ customerId: string; /** * The given name (that is, the first name) associated with the customer profile. * * The maximum length for this value is 300 characters. */ givenName?: string | null; /** * The family name (that is, the last name) associated with the customer profile. * * The maximum length for this value is 300 characters. */ familyName?: string | null; /** * A business name associated with the customer profile. * * The maximum length for this value is 500 characters. */ companyName?: string | null; /** * A nickname for the customer profile. * * The maximum length for this value is 100 characters. */ nickname?: string | null; /** * The email address associated with the customer profile. * * The maximum length for this value is 254 characters. */ emailAddress?: string | null; /** * The physical address associated with the customer profile. Only new or changed fields are required in the request. * * For maximum length constraints, see [Customer addresses](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#address). * The `first_name` and `last_name` fields are ignored if they are present in the request. */ address?: Square.Address; /** * The phone number associated with the customer profile. The phone number must be valid and can contain * 9–16 digits, with an optional `+` prefix and country code. For more information, see * [Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). */ phoneNumber?: string | null; /** * An optional second ID used to associate the customer profile with an * entity in another system. * * The maximum length for this value is 100 characters. */ referenceId?: string | null; /** A custom note associated with the customer profile. */ note?: string | null; /** * The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example, * specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD` * format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. */ birthday?: string | null; /** * The current version of the customer profile. * * As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile). */ version?: bigint; /** * The tax ID associated with the customer profile. This field is available only for customers of sellers * in EU countries or the United Kingdom. For more information, * see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). */ taxIds?: Square.CustomerTaxIds; }