Class CreateProfileRequest

    • Method Detail

      • domainName

        public final String domainName()

        The unique name of the domain.

        Returns:
        The unique name of the domain.
      • accountNumber

        public final String accountNumber()

        An account number that you have given to the customer.

        Returns:
        An 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.
      • partyType

        public final PartyType partyType()

        The type of profile used to describe the customer.

        If the service returns an enum value that is not available in the current SDK version, partyType will return PartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partyTypeAsString().

        Returns:
        The type of profile used to describe the customer.
        See Also:
        PartyType
      • partyTypeAsString

        public final String partyTypeAsString()

        The type of profile used to describe the customer.

        If the service returns an enum value that is not available in the current SDK version, partyType will return PartyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partyTypeAsString().

        Returns:
        The type of profile used to describe the customer.
        See Also:
        PartyType
      • businessName

        public final String businessName()

        The name of the customer’s business.

        Returns:
        The name of the customer’s business.
      • firstName

        public final String firstName()

        The customer’s first name.

        Returns:
        The customer’s first name.
      • middleName

        public final String middleName()

        The customer’s middle name.

        Returns:
        The customer’s middle name.
      • lastName

        public final String lastName()

        The customer’s last name.

        Returns:
        The customer’s last name.
      • birthDate

        public final String birthDate()

        The customer’s birth date.

        Returns:
        The customer’s birth date.
      • gender

        public final Gender gender()

        The gender with which the customer identifies.

        If the service returns an enum value that is not available in the current SDK version, gender will return Gender.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from genderAsString().

        Returns:
        The gender with which the customer identifies.
        See Also:
        Gender
      • genderAsString

        public final String genderAsString()

        The gender with which the customer identifies.

        If the service returns an enum value that is not available in the current SDK version, gender will return Gender.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from genderAsString().

        Returns:
        The gender with which the customer identifies.
        See Also:
        Gender
      • 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.
      • mobilePhoneNumber

        public final String mobilePhoneNumber()

        The customer’s mobile phone number.

        Returns:
        The customer’s mobile phone number.
      • homePhoneNumber

        public final String homePhoneNumber()

        The customer’s home phone number.

        Returns:
        The customer’s home phone number.
      • businessPhoneNumber

        public final String businessPhoneNumber()

        The customer’s business phone number.

        Returns:
        The customer’s business phone number.
      • 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.
      • personalEmailAddress

        public final String personalEmailAddress()

        The customer’s personal email address.

        Returns:
        The customer’s personal email address.
      • businessEmailAddress

        public final String businessEmailAddress()

        The customer’s business email address.

        Returns:
        The customer’s business email address.
      • address

        public final Address address()

        A generic address associated with the customer that is not mailing, shipping, or billing.

        Returns:
        A generic address associated with the customer that is not mailing, shipping, or billing.
      • shippingAddress

        public final Address shippingAddress()

        The customer’s shipping address.

        Returns:
        The customer’s shipping address.
      • mailingAddress

        public final Address mailingAddress()

        The customer’s mailing address.

        Returns:
        The customer’s mailing address.
      • billingAddress

        public final Address billingAddress()

        The customer’s billing address.

        Returns:
        The customer’s billing address.
      • hasAttributes

        public final boolean hasAttributes()
        For responses, this returns true if the service returned a value for the Attributes 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.
      • attributes

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

        A key value pair of attributes of a customer profile.

        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 hasAttributes() method.

        Returns:
        A key value pair of attributes of a customer profile.
      • partyTypeString

        public final String partyTypeString()

        An alternative to PartyType which accepts any string as input.

        Returns:
        An alternative to PartyType which accepts any string as input.
      • genderString

        public final String genderString()

        An alternative to Gender which accepts any string as input.

        Returns:
        An alternative to Gender which accepts any string as input.
      • 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