new Customer()
- Source:
Methods
(static) Customer#getAddresses() → {Array.<customers.Address>}
Get the field value
- Source:
Returns:
An array of
- Type
- Array.<customers.Address>
(static) Customer#getCards() → {Array.<customers.Card>}
Get the field value
- Source:
Returns:
An array of
- Type
- Array.<customers.Card>
(static) Customer#getCustomerSince() → {Number}
Get the field value
- Source:
Returns:
must be a long integer
- Type
- Number
(static) Customer#getEmailAddresses() → {Array.<customers.EmailAddress>}
Get the field value
- Source:
Returns:
An array of
- Type
- Array.<customers.EmailAddress>
(static) Customer#getFirstName() → {Null|String}
Get the field value
First/given name of the customer
- Source:
Returns:
- Type
- Null | String
(static) Customer#getId() → {String}
Get the field value
Unique identifier
- Source:
Returns:
- Type
- String
(static) Customer#getLastName() → {Null|String}
Get the field value
Last name/surname of the customer
- Source:
Returns:
- Type
- Null | String
(static) Customer#getMarketingAllowed() → {Boolean}
Get the field value
- Source:
Returns:
- Type
- Boolean
(static) Customer#getMerchant() → {base.Reference}
Get the field value
The merchant that is associated with this customer
- Source:
Returns:
- Type
- base.Reference
(static) Customer#getMetadata() → {customers.CustomerMetadata}
Get the field value
Additional information about the customer.
- Source:
Returns:
(static) Customer#getOrderRef() → {base.Reference}
Get the field value
The order with which the customer is associated
- Source:
Returns:
- Type
- base.Reference
(static) Customer#getOrders() → {Array.<base.Reference>}
Get the field value
- Source:
Returns:
An array of
- Type
- Array.<base.Reference>
(static) Customer#getPhoneNumbers() → {Array.<customers.PhoneNumber>}
Get the field value
- Source:
Returns:
An array of
- Type
- Array.<customers.PhoneNumber>
(static) Customer#setAddresses(addresses)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
addresses |
Array.<customers.Address> | An array of |
- Source:
(static) Customer#setCards(cards)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
cards |
Array.<customers.Card> | An array of |
- Source:
(static) Customer#setCustomerSince(customerSince)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
customerSince |
Number | must be a long integer |
- Source:
(static) Customer#setEmailAddresses(emailAddresses)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
emailAddresses |
Array.<customers.EmailAddress> | An array of |
- Source:
(static) Customer#setFirstName(firstName)
Set the field value
First/given name of the customer
Parameters:
Name | Type | Description |
---|---|---|
firstName |
Null | String |
- Source:
(static) Customer#setId(id)
Set the field value
Unique identifier
Parameters:
Name | Type | Description |
---|---|---|
id |
String |
- Source:
(static) Customer#setLastName(lastName)
Set the field value
Last name/surname of the customer
Parameters:
Name | Type | Description |
---|---|---|
lastName |
Null | String |
- Source:
(static) Customer#setMarketingAllowed(marketingAllowed)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
marketingAllowed |
Boolean |
- Source:
(static) Customer#setMerchant(merchant)
Set the field value
The merchant that is associated with this customer
Parameters:
Name | Type | Description |
---|---|---|
merchant |
base.Reference |
- Source:
(static) Customer#setMetadata(metadata)
Set the field value
Additional information about the customer.
Parameters:
Name | Type | Description |
---|---|---|
metadata |
customers.CustomerMetadata |
- Source:
(static) Customer#setOrderRef(orderRef)
Set the field value
The order with which the customer is associated
Parameters:
Name | Type | Description |
---|---|---|
orderRef |
base.Reference |
- Source:
(static) Customer#setOrders(orders)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
orders |
Array.<base.Reference> | An array of |
- Source:
(static) Customer#setPhoneNumbers(phoneNumbers)
Set the field value
Parameters:
Name | Type | Description |
---|---|---|
phoneNumbers |
Array.<customers.PhoneNumber> | An array of |
- Source: