Class CustomerDraftImpl
- All Implemented Interfaces:
CustomerDraft
,CustomizableDraft<CustomerDraft>
,WithKey
,io.vrap.rmf.base.client.Draft<CustomerDraft>
,io.vrap.rmf.base.client.ModelBase
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase
io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Addresses of the Customer.Identifies a Cart that will be assigned to the new Customer.Deprecated.Identifies Carts and Orders belonging to an anonymous session that will be assigned to the new Customer.Set toPassword
to make thepassword
field required for the Customer. Set toExternalAuth
when the password is not required for the Customer.Indices of the billing addresses in theaddresses
array.Company name of the Customer.Custom Fields for the Customer.Sets the CustomerGroup for the Customer.User-defined unique identifier for a Customer.Date of birth of the Customer.Index of the address in theaddresses
array to use as the default billing address.Index of the address in theaddresses
array to use as the default shipping address.getEmail()
Email address of the Customer that must be unique for an entire Project or to a Store the Customer is assigned to.Optional identifier for use in external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).Given name (first name) of the Customer.Set totrue
if the email address of the Customer has been verified already.getKey()
User-defined unique identifier for the Customer.Family name (last name) of the Customer.Preferred language of the Customer.Middle name of the Customer.Required whenauthenticationMode
is set toPassword
.Salutation of the Customer, for example, 'Mr.' or 'Mrs.'.Indices of the shipping addresses in theaddresses
array.Sets the Stores for the Customer.getTitle()
Title of the Customer, for example, 'Dr.'.getVatId()
Individual VAT ID of the Customer.int
hashCode()
void
setAddresses
(BaseAddress... addresses) Addresses of the Customer.void
setAddresses
(List<BaseAddress> addresses) Addresses of the Customer.void
setAnonymousCart
(CartResourceIdentifier anonymousCart) Identifies a Cart that will be assigned to the new Customer.void
setAnonymousCartId
(String anonymousCartId) Deprecated.void
setAnonymousId
(String anonymousId) Identifies Carts and Orders belonging to an anonymous session that will be assigned to the new Customer.void
setAuthenticationMode
(AuthenticationMode authenticationMode) Set toPassword
to make thepassword
field required for the Customer. Set toExternalAuth
when the password is not required for the Customer.void
setBillingAddresses
(Integer... billingAddresses) Indices of the billing addresses in theaddresses
array.void
setBillingAddresses
(List<Integer> billingAddresses) Indices of the billing addresses in theaddresses
array.void
setCompanyName
(String companyName) Company name of the Customer.void
setCustom
(CustomFieldsDraft custom) Custom Fields for the Customer.void
setCustomerGroup
(CustomerGroupResourceIdentifier customerGroup) Sets the CustomerGroup for the Customer.void
setCustomerNumber
(String customerNumber) User-defined unique identifier for a Customer.void
setDateOfBirth
(LocalDate dateOfBirth) Date of birth of the Customer.void
setDefaultBillingAddress
(Integer defaultBillingAddress) Index of the address in theaddresses
array to use as the default billing address.void
setDefaultShippingAddress
(Integer defaultShippingAddress) Index of the address in theaddresses
array to use as the default shipping address.void
Email address of the Customer that must be unique for an entire Project or to a Store the Customer is assigned to.void
setExternalId
(String externalId) Optional identifier for use in external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).void
setFirstName
(String firstName) Given name (first name) of the Customer.void
setIsEmailVerified
(Boolean isEmailVerified) Set totrue
if the email address of the Customer has been verified already.void
User-defined unique identifier for the Customer.void
setLastName
(String lastName) Family name (last name) of the Customer.void
Preferred language of the Customer.void
setMiddleName
(String middleName) Middle name of the Customer.void
setPassword
(String password) Required whenauthenticationMode
is set toPassword
.void
setSalutation
(String salutation) Salutation of the Customer, for example, 'Mr.' or 'Mrs.'.void
setShippingAddresses
(Integer... shippingAddresses) Indices of the shipping addresses in theaddresses
array.void
setShippingAddresses
(List<Integer> shippingAddresses) Indices of the shipping addresses in theaddresses
array.void
setStores
(StoreResourceIdentifier... stores) Sets the Stores for the Customer.void
setStores
(List<StoreResourceIdentifier> stores) Sets the Stores for the Customer.void
Title of the Customer, for example, 'Dr.'.void
Individual VAT ID of the Customer.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.commercetools.api.models.customer.CustomerDraft
withCustomerDraft
Methods inherited from interface com.commercetools.api.models.CustomizableDraft
unwrapCustomizableDraft
Methods inherited from interface io.vrap.rmf.base.client.ModelBase
reflectionString, reflectionString
-
Constructor Details
-
CustomerDraftImpl
public CustomerDraftImpl()create empty instance
-
-
Method Details
-
getKey
User-defined unique identifier for the Customer. The
key
field is preferred overcustomerNumber
as it is mutable and provides more flexibility.- Specified by:
getKey
in interfaceCustomerDraft
- Specified by:
getKey
in interfaceWithKey
- Returns:
- key
-
getCustomerNumber
User-defined unique identifier for a Customer. Once set, it cannot be changed.
Can be used to refer to a Customer in a human-readable way (in emails, invoices, and other correspondence).
- Specified by:
getCustomerNumber
in interfaceCustomerDraft
- Returns:
- customerNumber
-
getExternalId
Optional identifier for use in external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
- Specified by:
getExternalId
in interfaceCustomerDraft
- Returns:
- externalId
-
getEmail
Email address of the Customer that must be unique for an entire Project or to a Store the Customer is assigned to. It is the mandatory unique identifier of a Customer.
- Specified by:
getEmail
in interfaceCustomerDraft
- Returns:
-
getPassword
Required when
authenticationMode
is set toPassword
. Provide the Customer's password in plain text. The API stores passwords in an encrypted format.- Specified by:
getPassword
in interfaceCustomerDraft
- Returns:
- password
-
getFirstName
Given name (first name) of the Customer.
- Specified by:
getFirstName
in interfaceCustomerDraft
- Returns:
- firstName
-
getLastName
Family name (last name) of the Customer.
- Specified by:
getLastName
in interfaceCustomerDraft
- Returns:
- lastName
-
getMiddleName
Middle name of the Customer.
- Specified by:
getMiddleName
in interfaceCustomerDraft
- Returns:
- middleName
-
getTitle
Title of the Customer, for example, 'Dr.'.
- Specified by:
getTitle
in interfaceCustomerDraft
- Returns:
- title
-
getAnonymousCartId
Deprecated.Deprecated since an anonymous Cart can be identified by its
id
or externalkey
.- Specified by:
getAnonymousCartId
in interfaceCustomerDraft
- Returns:
- anonymousCartId
-
getAnonymousCart
Identifies a Cart that will be assigned to the new Customer.
- Specified by:
getAnonymousCart
in interfaceCustomerDraft
- Returns:
- anonymousCart
-
getAnonymousId
Identifies Carts and Orders belonging to an anonymous session that will be assigned to the new Customer.
- Specified by:
getAnonymousId
in interfaceCustomerDraft
- Returns:
- anonymousId
-
getDateOfBirth
Date of birth of the Customer.
- Specified by:
getDateOfBirth
in interfaceCustomerDraft
- Returns:
- dateOfBirth
-
getCompanyName
Company name of the Customer. When representing a company as a Customer, Business Units provide extended funtionality.
- Specified by:
getCompanyName
in interfaceCustomerDraft
- Returns:
- companyName
-
getVatId
Individual VAT ID of the Customer.
- Specified by:
getVatId
in interfaceCustomerDraft
- Returns:
- vatId
-
getAddresses
Addresses of the Customer.
- Specified by:
getAddresses
in interfaceCustomerDraft
- Returns:
- addresses
-
getDefaultShippingAddress
Index of the address in the
addresses
array to use as the default shipping address. ThedefaultShippingAddressId
of the Customer will be set to theid
of that address.- Specified by:
getDefaultShippingAddress
in interfaceCustomerDraft
- Returns:
- defaultShippingAddress
-
getShippingAddresses
Indices of the shipping addresses in the
addresses
array. TheshippingAddressIds
of the Customer will be set to the IDs of these addresses.- Specified by:
getShippingAddresses
in interfaceCustomerDraft
- Returns:
- shippingAddresses
-
getDefaultBillingAddress
Index of the address in the
addresses
array to use as the default billing address. ThedefaultBillingAddressId
of the Customer will be set to theid
of that address.- Specified by:
getDefaultBillingAddress
in interfaceCustomerDraft
- Returns:
- defaultBillingAddress
-
getBillingAddresses
Indices of the billing addresses in the
addresses
array. ThebillingAddressIds
of the Customer will be set to the IDs of these addresses.- Specified by:
getBillingAddresses
in interfaceCustomerDraft
- Returns:
- billingAddresses
-
getIsEmailVerified
Set to
true
if the email address of the Customer has been verified already. The intended use is to leave this field unset upon sign-up of the Customer and initiate the email verification afterwards.- Specified by:
getIsEmailVerified
in interfaceCustomerDraft
- Returns:
- isEmailVerified
-
getCustomerGroup
Sets the CustomerGroup for the Customer.
- Specified by:
getCustomerGroup
in interfaceCustomerDraft
- Returns:
- customerGroup
-
getCustom
Custom Fields for the Customer.
- Specified by:
getCustom
in interfaceCustomerDraft
- Specified by:
getCustom
in interfaceCustomizableDraft<CustomerDraft>
- Returns:
- custom
-
getLocale
Preferred language of the Customer. Must be one of the languages supported by the Project.
- Specified by:
getLocale
in interfaceCustomerDraft
- Returns:
- locale
-
getSalutation
Salutation of the Customer, for example, 'Mr.' or 'Mrs.'.
- Specified by:
getSalutation
in interfaceCustomerDraft
- Returns:
- salutation
-
getStores
Sets the Stores for the Customer.
- If no Stores are specified, the Customer is a global customer, and can log in using the Password Flow for global Customers.
- If any Stores are specified, the Customer can only log in using the Password Flow for Customers in a Store for those specific Stores.
- Specified by:
getStores
in interfaceCustomerDraft
- Returns:
- stores
-
getAuthenticationMode
- Set to
Password
to make thepassword
field required for the Customer. - Set to
ExternalAuth
when the password is not required for the Customer.
- Specified by:
getAuthenticationMode
in interfaceCustomerDraft
- Returns:
- authenticationMode
- Set to
-
setKey
Description copied from interface:CustomerDraft
User-defined unique identifier for the Customer. The
key
field is preferred overcustomerNumber
as it is mutable and provides more flexibility.- Specified by:
setKey
in interfaceCustomerDraft
- Parameters:
key
- value to be set
-
setCustomerNumber
Description copied from interface:CustomerDraft
User-defined unique identifier for a Customer. Once set, it cannot be changed.
Can be used to refer to a Customer in a human-readable way (in emails, invoices, and other correspondence).
- Specified by:
setCustomerNumber
in interfaceCustomerDraft
- Parameters:
customerNumber
- value to be set
-
setExternalId
Description copied from interface:CustomerDraft
Optional identifier for use in external systems like Customer Relationship Management (CRM) or Enterprise Resource Planning (ERP).
- Specified by:
setExternalId
in interfaceCustomerDraft
- Parameters:
externalId
- value to be set
-
setEmail
Description copied from interface:CustomerDraft
Email address of the Customer that must be unique for an entire Project or to a Store the Customer is assigned to. It is the mandatory unique identifier of a Customer.
- Specified by:
setEmail
in interfaceCustomerDraft
- Parameters:
email
- value to be set
-
setPassword
Description copied from interface:CustomerDraft
Required when
authenticationMode
is set toPassword
. Provide the Customer's password in plain text. The API stores passwords in an encrypted format.- Specified by:
setPassword
in interfaceCustomerDraft
- Parameters:
password
- value to be set
-
setFirstName
Description copied from interface:CustomerDraft
Given name (first name) of the Customer.
- Specified by:
setFirstName
in interfaceCustomerDraft
- Parameters:
firstName
- value to be set
-
setLastName
Description copied from interface:CustomerDraft
Family name (last name) of the Customer.
- Specified by:
setLastName
in interfaceCustomerDraft
- Parameters:
lastName
- value to be set
-
setMiddleName
Description copied from interface:CustomerDraft
Middle name of the Customer.
- Specified by:
setMiddleName
in interfaceCustomerDraft
- Parameters:
middleName
- value to be set
-
setTitle
Description copied from interface:CustomerDraft
Title of the Customer, for example, 'Dr.'.
- Specified by:
setTitle
in interfaceCustomerDraft
- Parameters:
title
- value to be set
-
setAnonymousCartId
Deprecated.Description copied from interface:CustomerDraft
Deprecated since an anonymous Cart can be identified by its
id
or externalkey
.- Specified by:
setAnonymousCartId
in interfaceCustomerDraft
- Parameters:
anonymousCartId
- value to be set
-
setAnonymousCart
Description copied from interface:CustomerDraft
Identifies a Cart that will be assigned to the new Customer.
- Specified by:
setAnonymousCart
in interfaceCustomerDraft
- Parameters:
anonymousCart
- value to be set
-
setAnonymousId
Description copied from interface:CustomerDraft
Identifies Carts and Orders belonging to an anonymous session that will be assigned to the new Customer.
- Specified by:
setAnonymousId
in interfaceCustomerDraft
- Parameters:
anonymousId
- value to be set
-
setDateOfBirth
Description copied from interface:CustomerDraft
Date of birth of the Customer.
- Specified by:
setDateOfBirth
in interfaceCustomerDraft
- Parameters:
dateOfBirth
- value to be set
-
setCompanyName
Description copied from interface:CustomerDraft
Company name of the Customer. When representing a company as a Customer, Business Units provide extended funtionality.
- Specified by:
setCompanyName
in interfaceCustomerDraft
- Parameters:
companyName
- value to be set
-
setVatId
Description copied from interface:CustomerDraft
Individual VAT ID of the Customer.
- Specified by:
setVatId
in interfaceCustomerDraft
- Parameters:
vatId
- value to be set
-
setAddresses
Description copied from interface:CustomerDraft
Addresses of the Customer.
- Specified by:
setAddresses
in interfaceCustomerDraft
- Parameters:
addresses
- values to be set
-
setAddresses
Description copied from interface:CustomerDraft
Addresses of the Customer.
- Specified by:
setAddresses
in interfaceCustomerDraft
- Parameters:
addresses
- values to be set
-
setDefaultShippingAddress
Description copied from interface:CustomerDraft
Index of the address in the
addresses
array to use as the default shipping address. ThedefaultShippingAddressId
of the Customer will be set to theid
of that address.- Specified by:
setDefaultShippingAddress
in interfaceCustomerDraft
- Parameters:
defaultShippingAddress
- value to be set
-
setShippingAddresses
Description copied from interface:CustomerDraft
Indices of the shipping addresses in the
addresses
array. TheshippingAddressIds
of the Customer will be set to the IDs of these addresses.- Specified by:
setShippingAddresses
in interfaceCustomerDraft
- Parameters:
shippingAddresses
- values to be set
-
setShippingAddresses
Description copied from interface:CustomerDraft
Indices of the shipping addresses in the
addresses
array. TheshippingAddressIds
of the Customer will be set to the IDs of these addresses.- Specified by:
setShippingAddresses
in interfaceCustomerDraft
- Parameters:
shippingAddresses
- values to be set
-
setDefaultBillingAddress
Description copied from interface:CustomerDraft
Index of the address in the
addresses
array to use as the default billing address. ThedefaultBillingAddressId
of the Customer will be set to theid
of that address.- Specified by:
setDefaultBillingAddress
in interfaceCustomerDraft
- Parameters:
defaultBillingAddress
- value to be set
-
setBillingAddresses
Description copied from interface:CustomerDraft
Indices of the billing addresses in the
addresses
array. ThebillingAddressIds
of the Customer will be set to the IDs of these addresses.- Specified by:
setBillingAddresses
in interfaceCustomerDraft
- Parameters:
billingAddresses
- values to be set
-
setBillingAddresses
Description copied from interface:CustomerDraft
Indices of the billing addresses in the
addresses
array. ThebillingAddressIds
of the Customer will be set to the IDs of these addresses.- Specified by:
setBillingAddresses
in interfaceCustomerDraft
- Parameters:
billingAddresses
- values to be set
-
setIsEmailVerified
Description copied from interface:CustomerDraft
Set to
true
if the email address of the Customer has been verified already. The intended use is to leave this field unset upon sign-up of the Customer and initiate the email verification afterwards.- Specified by:
setIsEmailVerified
in interfaceCustomerDraft
- Parameters:
isEmailVerified
- value to be set
-
setCustomerGroup
Description copied from interface:CustomerDraft
Sets the CustomerGroup for the Customer.
- Specified by:
setCustomerGroup
in interfaceCustomerDraft
- Parameters:
customerGroup
- value to be set
-
setCustom
Description copied from interface:CustomerDraft
Custom Fields for the Customer.
- Specified by:
setCustom
in interfaceCustomerDraft
- Specified by:
setCustom
in interfaceCustomizableDraft<CustomerDraft>
- Parameters:
custom
- value to be set
-
setLocale
Description copied from interface:CustomerDraft
Preferred language of the Customer. Must be one of the languages supported by the Project.
- Specified by:
setLocale
in interfaceCustomerDraft
- Parameters:
locale
- value to be set
-
setSalutation
Description copied from interface:CustomerDraft
Salutation of the Customer, for example, 'Mr.' or 'Mrs.'.
- Specified by:
setSalutation
in interfaceCustomerDraft
- Parameters:
salutation
- value to be set
-
setStores
Description copied from interface:CustomerDraft
Sets the Stores for the Customer.
- If no Stores are specified, the Customer is a global customer, and can log in using the Password Flow for global Customers.
- If any Stores are specified, the Customer can only log in using the Password Flow for Customers in a Store for those specific Stores.
- Specified by:
setStores
in interfaceCustomerDraft
- Parameters:
stores
- values to be set
-
setStores
Description copied from interface:CustomerDraft
Sets the Stores for the Customer.
- If no Stores are specified, the Customer is a global customer, and can log in using the Password Flow for global Customers.
- If any Stores are specified, the Customer can only log in using the Password Flow for Customers in a Store for those specific Stores.
- Specified by:
setStores
in interfaceCustomerDraft
- Parameters:
stores
- values to be set
-
setAuthenticationMode
Description copied from interface:CustomerDraft
- Set to
Password
to make thepassword
field required for the Customer. - Set to
ExternalAuth
when the password is not required for the Customer.
- Specified by:
setAuthenticationMode
in interfaceCustomerDraft
- Parameters:
authenticationMode
- value to be set
- Set to
-
equals
-
hashCode
-