module:models/UpdateCustomerRequest()

new module:models/UpdateCustomerRequest()

This class subject to change without prior notice, Please dont use this class directly.

Constructs a new UpdateCustomerRequest.

Members

static, readonly GenderEnum :String

Allowed values for the gender property.

Properties:
Name Type Description
male String

value: "male"

female String

value: "female"

static, readonly StatusEnum :String

Allowed values for the status property.

Properties:
Name Type Description
active String

value: "active"

revoked String

value: "revoked"

suspended String

value: "suspended"

inner address :module:models/AddressVo

inner comments :String

Comments that can be used to recollect the operation performed on the resource object.

inner custom_fields :Object.<String, String>

The additional information or meta-information that EBPP can accept, maintain and transmit back to the client.

inner customer_accounts :Array.<module:models/UpdateCustomerAccountRequest>

inner date_of_birth :String

The date of birth of the customer. It should be in the full-date format as per ISO8601, namely, YYYY-MM-DD.

inner email :String

The email address of the customer to which notifications from EBPP will be sent.

inner first_name :String

The first name of the customer.

inner gender :module:models/UpdateCustomerRequest.GenderEnum

The gender of the customer.

inner home_phone :String

The home phone number of the customer.

inner last_name :String

The last name of the customer.

inner locale :String

The language in which the customer wants the alerts and notifications from EBPP. This is to be specified in the format,
< ISO-639-1 language code >_< ISO ALPHA-2 Country Code >.
For e.g., en_US indicates the language preference as US English, which is also the default value.

inner middle_name :String

The middle name of the customer.

inner mobile_phone :String

The mobile phone number of the customer.

inner registered_email :String

The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in EBPP.

inner ssn :String

The SSN of the customer if the account holder is an individual or the tax ID, if the customer is a business.

inner status :module:models/UpdateCustomerRequest.StatusEnum

The status of the customer in EBPP.

inner work_phone :String

The work phone number of the customer.

Methods

static constructFromObject(data, obj) → {module:models/UpdateCustomerRequest}

Constructs a UpdateCustomerRequest from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:models/UpdateCustomerRequest

Optional instance to populate.

Returns:
module:models/UpdateCustomerRequest -

The populated UpdateCustomerRequest instance.