import type * as Square from "../index"; /** * Represents a Square customer profile in the Customer Directory of a Square seller. */ export interface Customer { /** * A unique Square-assigned ID for the customer profile. * * If you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](api-endpoint:Customers-SearchCustomers) * or [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint. */ id?: string; /** The timestamp when the customer profile was created, in RFC 3339 format. */ createdAt?: string; /** The timestamp when the customer profile was last updated, in RFC 3339 format. */ updatedAt?: string; /** The given name (that is, the first name) associated with the customer profile. */ givenName?: string | null; /** The family name (that is, the last name) associated with the customer profile. */ familyName?: string | null; /** A nickname for the customer profile. */ nickname?: string | null; /** A business name associated with the customer profile. */ companyName?: string | null; /** The email address associated with the customer profile. */ emailAddress?: string | null; /** The physical address associated with the customer profile. */ address?: Square.Address; /** The phone number associated with the customer profile. */ phoneNumber?: string | null; /** * The birthday associated with the customer profile, in `YYYY-MM-DD` format. For example, `1998-09-21` * represents September 21, 1998, and `0000-09-21` represents September 21 (without a birth year). */ birthday?: string | null; /** * An optional second ID used to associate the customer profile with an * entity in another system. */ referenceId?: string | null; /** A custom note associated with the customer profile. */ note?: string | null; /** Represents general customer preferences. */ preferences?: Square.CustomerPreferences; /** * The method used to create the customer profile. * See [CustomerCreationSource](#type-customercreationsource) for possible values */ creationSource?: Square.CustomerCreationSource; /** The IDs of [customer groups](entity:CustomerGroup) the customer belongs to. */ groupIds?: string[] | null; /** The IDs of [customer segments](entity:CustomerSegment) the customer belongs to. */ segmentIds?: string[] | null; /** The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership. */ version?: bigint; /** * The tax ID associated with the customer profile. This field is present 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; }