Class CustomerProfileAttributes

    • Method Detail

      • accountNumber

        public final String accountNumber()

        A unique account number that you have given to the customer.

        Returns:
        A unique account number that you have given to the customer.
      • additionalInformation

        public final String additionalInformation()

        Any additional information relevant to the customer's profile.

        Returns:
        Any additional information relevant to the customer's profile.
      • address1

        public final String address1()

        The first line of a customer address.

        Returns:
        The first line of a customer address.
      • address2

        public final String address2()

        The second line of a customer address.

        Returns:
        The second line of a customer address.
      • address3

        public final String address3()

        The third line of a customer address.

        Returns:
        The third line of a customer address.
      • address4

        public final String address4()

        The fourth line of a customer address.

        Returns:
        The fourth line of a customer address.
      • billingAddress1

        public final String billingAddress1()

        The first line of a customer’s billing address.

        Returns:
        The first line of a customer’s billing address.
      • billingAddress2

        public final String billingAddress2()

        The second line of a customer’s billing address.

        Returns:
        The second line of a customer’s billing address.
      • billingAddress3

        public final String billingAddress3()

        The third line of a customer’s billing address.

        Returns:
        The third line of a customer’s billing address.
      • billingAddress4

        public final String billingAddress4()

        The fourth line of a customer’s billing address.

        Returns:
        The fourth line of a customer’s billing address.
      • billingCity

        public final String billingCity()

        The city of a customer’s billing address.

        Returns:
        The city of a customer’s billing address.
      • billingCountry

        public final String billingCountry()

        The country of a customer’s billing address.

        Returns:
        The country of a customer’s billing address.
      • billingCounty

        public final String billingCounty()

        The county of a customer’s billing address.

        Returns:
        The county of a customer’s billing address.
      • billingPostalCode

        public final String billingPostalCode()

        The postal code of a customer’s billing address.

        Returns:
        The postal code of a customer’s billing address.
      • billingProvince

        public final String billingProvince()

        The province of a customer’s billing address.

        Returns:
        The province of a customer’s billing address.
      • billingState

        public final String billingState()

        The state of a customer’s billing address.

        Returns:
        The state of a customer’s billing address.
      • birthDate

        public final String birthDate()

        The customer's birth date.

        Returns:
        The customer's birth date.
      • businessEmailAddress

        public final String businessEmailAddress()

        The customer's business email address.

        Returns:
        The customer's business email address.
      • businessName

        public final String businessName()

        The name of the customer's business.

        Returns:
        The name of the customer's business.
      • businessPhoneNumber

        public final String businessPhoneNumber()

        The customer's business phone number.

        Returns:
        The customer's business phone number.
      • city

        public final String city()

        The city in which a customer lives.

        Returns:
        The city in which a customer lives.
      • country

        public final String country()

        The country in which a customer lives.

        Returns:
        The country in which a customer lives.
      • county

        public final String county()

        The county in which a customer lives.

        Returns:
        The county in which a customer lives.
      • hasCustom

        public final boolean hasCustom()
        For responses, this returns true if the service returned a value for the Custom property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • custom

        public final Map<String,​String> custom()

        The custom attributes in customer profile attributes.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustom() method.

        Returns:
        The custom attributes in customer profile attributes.
      • emailAddress

        public final String emailAddress()

        The customer's email address, which has not been specified as a personal or business address.

        Returns:
        The customer's email address, which has not been specified as a personal or business address.
      • firstName

        public final String firstName()

        The customer's first name.

        Returns:
        The customer's first name.
      • gender

        public final String gender()

        The customer's gender.

        Returns:
        The customer's gender.
      • homePhoneNumber

        public final String homePhoneNumber()

        The customer's mobile phone number.

        Returns:
        The customer's mobile phone number.
      • lastName

        public final String lastName()

        The customer's last name.

        Returns:
        The customer's last name.
      • mailingAddress1

        public final String mailingAddress1()

        The first line of a customer’s mailing address.

        Returns:
        The first line of a customer’s mailing address.
      • mailingAddress2

        public final String mailingAddress2()

        The second line of a customer’s mailing address.

        Returns:
        The second line of a customer’s mailing address.
      • mailingAddress3

        public final String mailingAddress3()

        The third line of a customer’s mailing address.

        Returns:
        The third line of a customer’s mailing address.
      • mailingAddress4

        public final String mailingAddress4()

        The fourth line of a customer’s mailing address.

        Returns:
        The fourth line of a customer’s mailing address.
      • mailingCity

        public final String mailingCity()

        The city of a customer’s mailing address.

        Returns:
        The city of a customer’s mailing address.
      • mailingCountry

        public final String mailingCountry()

        The country of a customer’s mailing address.

        Returns:
        The country of a customer’s mailing address.
      • mailingCounty

        public final String mailingCounty()

        The county of a customer’s mailing address.

        Returns:
        The county of a customer’s mailing address.
      • mailingPostalCode

        public final String mailingPostalCode()

        The postal code of a customer’s mailing address.

        Returns:
        The postal code of a customer’s mailing address.
      • mailingProvince

        public final String mailingProvince()

        The province of a customer’s mailing address.

        Returns:
        The province of a customer’s mailing address.
      • mailingState

        public final String mailingState()

        The state of a customer’s mailing address.

        Returns:
        The state of a customer’s mailing address.
      • middleName

        public final String middleName()

        The customer's middle name.

        Returns:
        The customer's middle name.
      • mobilePhoneNumber

        public final String mobilePhoneNumber()

        The customer's mobile phone number.

        Returns:
        The customer's mobile phone number.
      • partyType

        public final String partyType()

        The customer's party type.

        Returns:
        The customer's party type.
      • phoneNumber

        public final String phoneNumber()

        The customer's phone number, which has not been specified as a mobile, home, or business number.

        Returns:
        The customer's phone number, which has not been specified as a mobile, home, or business number.
      • postalCode

        public final String postalCode()

        The postal code of a customer address.

        Returns:
        The postal code of a customer address.
      • profileARN

        public final String profileARN()

        The ARN of a customer profile.

        Returns:
        The ARN of a customer profile.
      • profileId

        public final String profileId()

        The unique identifier of a customer profile.

        Returns:
        The unique identifier of a customer profile.
      • province

        public final String province()

        The province in which a customer lives.

        Returns:
        The province in which a customer lives.
      • shippingAddress1

        public final String shippingAddress1()

        The first line of a customer’s shipping address.

        Returns:
        The first line of a customer’s shipping address.
      • shippingAddress2

        public final String shippingAddress2()

        The second line of a customer’s shipping address.

        Returns:
        The second line of a customer’s shipping address.
      • shippingAddress3

        public final String shippingAddress3()

        The third line of a customer’s shipping address.

        Returns:
        The third line of a customer’s shipping address.
      • shippingAddress4

        public final String shippingAddress4()

        The fourth line of a customer’s shipping address.

        Returns:
        The fourth line of a customer’s shipping address.
      • shippingCity

        public final String shippingCity()

        The city of a customer’s shipping address.

        Returns:
        The city of a customer’s shipping address.
      • shippingCountry

        public final String shippingCountry()

        The country of a customer’s shipping address.

        Returns:
        The country of a customer’s shipping address.
      • shippingCounty

        public final String shippingCounty()

        The county of a customer’s shipping address.

        Returns:
        The county of a customer’s shipping address.
      • shippingPostalCode

        public final String shippingPostalCode()

        The postal code of a customer’s shipping address.

        Returns:
        The postal code of a customer’s shipping address.
      • shippingProvince

        public final String shippingProvince()

        The province of a customer’s shipping address.

        Returns:
        The province of a customer’s shipping address.
      • shippingState

        public final String shippingState()

        The state of a customer’s shipping address.

        Returns:
        The state of a customer’s shipping address.
      • state

        public final String state()

        The state in which a customer lives.

        Returns:
        The state in which a customer lives.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)