@square/web-payments-sdk-types/dist/v1/types/contact.d.ts

Types for Square's Web Payments SDK

/**
 * A buyer
 *
 * The `Contact` includes contact information about the buyer.
 * @example
 * const buyer = {
 *    "givenName": "John",
 *    "familyName": "Doe",
 *    "addressLines": [
 *       "123 East Main Street",
 *       "#111"
 *    ],
 *    "city": "Seattle",
 *    "state": "WA",
 *    "postalCode": "98111",
 *    "countryCode": "US",
 *    "email": "johndoe@example.com",
 *    "phone": "+12065551212"
 * }
 */
interface Contact {
    /**
     * First/given name.
     *
     * For mononyms and other such names, provide the full name as `givenName`.
     */
    givenName?: string;
    /**
     * Last/family name.
     */
    familyName?: string;
    /**
     * Street address lines.
     */
    addressLines?: string[];
    /**
     * City/locality name.
     */
    city?: string;
    /**
     * State/province/region name.
     */
    state?: string;
    /**
     * Postal code.
     */
    postalCode?: string;
    /**
     * Two-letter ISO 3166-1 country code.
     */
    countryCode?: string;
    /**
     * Email address.
     */
    email?: string;
    /**
     * Telephone number.
     */
    phone?: string;
}
/**
 * A buyer
 *
 * The `BillingContact` includes contact information about the buyer.
 * @example
 * const buyer = {
 *    "givenName": "John",
 *    "familyName": "Doe",
 *    "addressLines": [
 *       "123 East Main Street",
 *       "#111"
 *    ],
 *    "city": "Seattle",
 *    "state": "WA",
 *    "postalCode": "98111",
 *    "countryCode": "US",
 *    "email": "johndoe@example.com",
 *    "phone": "+12065551212"
 * }
 */
type BillingContact = Contact;
/**
 * A digital wallet shipping contact
 *
 * `ShippingContact` contains name, address, email, and contact phone information
 * to be shown in a digital wallet payment form.
 * @example
 * const buyer = {
 *    "givenName": "John",
 *    "familyName": "Doe",
 *    "addressLines": [
 *       "123 East Main Street",
 *       "#111"
 *    ],
 *    "city": "Seattle",
 *    "state": "WA",
 *    "postalCode": "98111",
 *    "countryCode": "US",
 *    "email": "johndoe@example.com",
 *    "phone": "+12065551212"
 * }
 */
type ShippingContact = Contact;
export { BillingContact, ShippingContact };