public static interface Profile.Builder extends SdkPojo, CopyableBuilder<Profile.Builder,Profile>
| Modifier and Type | Method and Description |
|---|---|
Profile.Builder |
accountNumber(String accountNumber)
A unique account number that you have given to the customer.
|
Profile.Builder |
additionalInformation(String additionalInformation)
Any additional information relevant to the customer’s profile.
|
Profile.Builder |
address(Address address)
A generic address associated with the customer that is not mailing, shipping, or billing.
|
default Profile.Builder |
address(Consumer<Address.Builder> address)
A generic address associated with the customer that is not mailing, shipping, or billing.
|
Profile.Builder |
attributes(Map<String,String> attributes)
A key value pair of attributes of a customer profile.
|
Profile.Builder |
billingAddress(Address billingAddress)
The customer’s billing address.
|
default Profile.Builder |
billingAddress(Consumer<Address.Builder> billingAddress)
The customer’s billing address.
|
Profile.Builder |
birthDate(String birthDate)
The customer’s birth date.
|
Profile.Builder |
businessEmailAddress(String businessEmailAddress)
The customer’s business email address.
|
Profile.Builder |
businessName(String businessName)
The name of the customer’s business.
|
Profile.Builder |
businessPhoneNumber(String businessPhoneNumber)
The customer’s home phone number.
|
Profile.Builder |
emailAddress(String emailAddress)
The customer’s email address, which has not been specified as a personal or business address.
|
Profile.Builder |
firstName(String firstName)
The customer’s first name.
|
Profile.Builder |
foundByItems(Collection<FoundByKeyValue> foundByItems)
A list of items used to find a profile returned in a SearchProfiles response.
|
Profile.Builder |
foundByItems(Consumer<FoundByKeyValue.Builder>... foundByItems)
A list of items used to find a profile returned in a SearchProfiles response.
|
Profile.Builder |
foundByItems(FoundByKeyValue... foundByItems)
A list of items used to find a profile returned in a SearchProfiles response.
|
Profile.Builder |
gender(Gender gender)
The gender with which the customer identifies.
|
Profile.Builder |
gender(String gender)
The gender with which the customer identifies.
|
Profile.Builder |
homePhoneNumber(String homePhoneNumber)
The customer’s home phone number.
|
Profile.Builder |
lastName(String lastName)
The customer’s last name.
|
Profile.Builder |
mailingAddress(Address mailingAddress)
The customer’s mailing address.
|
default Profile.Builder |
mailingAddress(Consumer<Address.Builder> mailingAddress)
The customer’s mailing address.
|
Profile.Builder |
middleName(String middleName)
The customer’s middle name.
|
Profile.Builder |
mobilePhoneNumber(String mobilePhoneNumber)
The customer’s mobile phone number.
|
Profile.Builder |
partyType(PartyType partyType)
The type of profile used to describe the customer.
|
Profile.Builder |
partyType(String partyType)
The type of profile used to describe the customer.
|
Profile.Builder |
personalEmailAddress(String personalEmailAddress)
The customer’s personal email address.
|
Profile.Builder |
phoneNumber(String phoneNumber)
The customer's phone number, which has not been specified as a mobile, home, or business number.
|
Profile.Builder |
profileId(String profileId)
The unique identifier of a customer profile.
|
Profile.Builder |
shippingAddress(Address shippingAddress)
The customer’s shipping address.
|
default Profile.Builder |
shippingAddress(Consumer<Address.Builder> shippingAddress)
The customer’s shipping address.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildProfile.Builder profileId(String profileId)
The unique identifier of a customer profile.
profileId - The unique identifier of a customer profile.Profile.Builder accountNumber(String accountNumber)
A unique account number that you have given to the customer.
accountNumber - A unique account number that you have given to the customer.Profile.Builder additionalInformation(String additionalInformation)
Any additional information relevant to the customer’s profile.
additionalInformation - Any additional information relevant to the customer’s profile.Profile.Builder partyType(String partyType)
The type of profile used to describe the customer.
Profile.Builder partyType(PartyType partyType)
The type of profile used to describe the customer.
Profile.Builder businessName(String businessName)
The name of the customer’s business.
businessName - The name of the customer’s business.Profile.Builder firstName(String firstName)
The customer’s first name.
firstName - The customer’s first name.Profile.Builder middleName(String middleName)
The customer’s middle name.
middleName - The customer’s middle name.Profile.Builder lastName(String lastName)
The customer’s last name.
lastName - The customer’s last name.Profile.Builder birthDate(String birthDate)
The customer’s birth date.
birthDate - The customer’s birth date.Profile.Builder gender(String gender)
The gender with which the customer identifies.
Profile.Builder gender(Gender gender)
The gender with which the customer identifies.
Profile.Builder phoneNumber(String phoneNumber)
The customer's phone number, which has not been specified as a mobile, home, or business number.
phoneNumber - The customer's phone number, which has not been specified as a mobile, home, or business number.Profile.Builder mobilePhoneNumber(String mobilePhoneNumber)
The customer’s mobile phone number.
mobilePhoneNumber - The customer’s mobile phone number.Profile.Builder homePhoneNumber(String homePhoneNumber)
The customer’s home phone number.
homePhoneNumber - The customer’s home phone number.Profile.Builder businessPhoneNumber(String businessPhoneNumber)
The customer’s home phone number.
businessPhoneNumber - The customer’s home phone number.Profile.Builder emailAddress(String emailAddress)
The customer’s email address, which has not been specified as a personal or business address.
emailAddress - The customer’s email address, which has not been specified as a personal or business address.Profile.Builder personalEmailAddress(String personalEmailAddress)
The customer’s personal email address.
personalEmailAddress - The customer’s personal email address.Profile.Builder businessEmailAddress(String businessEmailAddress)
The customer’s business email address.
businessEmailAddress - The customer’s business email address.Profile.Builder address(Address address)
A generic address associated with the customer that is not mailing, shipping, or billing.
address - A generic address associated with the customer that is not mailing, shipping, or billing.default Profile.Builder address(Consumer<Address.Builder> address)
A generic address associated with the customer that is not mailing, shipping, or billing.
This is a convenience method that creates an instance of theAddress.Builder avoiding the need to
create one manually via Address.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to address(Address).
address - a consumer that will call methods on Address.Builderaddress(Address)Profile.Builder shippingAddress(Address shippingAddress)
The customer’s shipping address.
shippingAddress - The customer’s shipping address.default Profile.Builder shippingAddress(Consumer<Address.Builder> shippingAddress)
The customer’s shipping address.
This is a convenience method that creates an instance of theAddress.Builder avoiding the need to
create one manually via Address.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to shippingAddress(Address).
shippingAddress - a consumer that will call methods on Address.BuildershippingAddress(Address)Profile.Builder mailingAddress(Address mailingAddress)
The customer’s mailing address.
mailingAddress - The customer’s mailing address.default Profile.Builder mailingAddress(Consumer<Address.Builder> mailingAddress)
The customer’s mailing address.
This is a convenience method that creates an instance of theAddress.Builder avoiding the need to
create one manually via Address.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to mailingAddress(Address).
mailingAddress - a consumer that will call methods on Address.BuildermailingAddress(Address)Profile.Builder billingAddress(Address billingAddress)
The customer’s billing address.
billingAddress - The customer’s billing address.default Profile.Builder billingAddress(Consumer<Address.Builder> billingAddress)
The customer’s billing address.
This is a convenience method that creates an instance of theAddress.Builder avoiding the need to
create one manually via Address.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to billingAddress(Address).
billingAddress - a consumer that will call methods on Address.BuilderbillingAddress(Address)Profile.Builder attributes(Map<String,String> attributes)
A key value pair of attributes of a customer profile.
attributes - A key value pair of attributes of a customer profile.Profile.Builder foundByItems(Collection<FoundByKeyValue> foundByItems)
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the
LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in the
request. The FoundByItems will include all of the key-value(s) pairs that were specified in the
request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in
the request. The FoundByItems will include each of the key-value(s) pairs that the profile was
found by.
The OR relationship is the default behavior if the LogicalOperator parameter is not
included in the SearchProfiles request.
foundByItems - A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the
profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the
LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in
the request. The FoundByItems will include all of the key-value(s) pairs that were
specified in the request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys
specified in the request. The FoundByItems will include each of the key-value(s) pairs
that the profile was found by.
The OR relationship is the default behavior if the LogicalOperator parameter
is not included in the SearchProfiles request.
Profile.Builder foundByItems(FoundByKeyValue... foundByItems)
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the
LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in the
request. The FoundByItems will include all of the key-value(s) pairs that were specified in the
request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in
the request. The FoundByItems will include each of the key-value(s) pairs that the profile was
found by.
The OR relationship is the default behavior if the LogicalOperator parameter is not
included in the SearchProfiles request.
foundByItems - A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the
profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the
LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in
the request. The FoundByItems will include all of the key-value(s) pairs that were
specified in the request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys
specified in the request. The FoundByItems will include each of the key-value(s) pairs
that the profile was found by.
The OR relationship is the default behavior if the LogicalOperator parameter
is not included in the SearchProfiles request.
Profile.Builder foundByItems(Consumer<FoundByKeyValue.Builder>... foundByItems)
A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.
If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the
LogicalOperator used in the request:
AND - The profile included in the response matched all of the search keys specified in the
request. The FoundByItems will include all of the key-value(s) pairs that were specified in the
request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in
the request. The FoundByItems will include each of the key-value(s) pairs that the profile was
found by.
The OR relationship is the default behavior if the LogicalOperator parameter is not
included in the SearchProfiles request.
FoundByKeyValue.Builder avoiding the need to
create one manually via
FoundByKeyValue.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #foundByItems(List.
foundByItems - a consumer that will call methods on
FoundByKeyValue.Builder#foundByItems(java.util.Collection) Copyright © 2023. All rights reserved.