Class OrderAddress
The Address class represents a customer's address.
Note: this class allows access to sensitive personal and private information. Pay attention to appropriate legal and regulatory requirements.
| Property | Description |
|---|---|
| address1: String | Returns the customer's first address. |
| address2: String | Returns the customer's second address. |
| city: String | Returns the Customer's City. |
| companyName: String | Returns the Customer's company name. |
| countryCode: EnumValue | Returns the customer's country code. |
| firstName: String | Returns the Customer's first name. |
fullName: String (read-only) | Returns a concatenation of the Customer's first, middle, and last names and it' suffix. |
| jobTitle: String | Returns the customer's job title. |
| lastName: String | Returns the customer's last name. |
| phone: String | Returns the customer's phone number. |
| postBox: String | Returns the customer's post box. |
| postalCode: String | Returns the customer's postal code. |
| salutation: String | Returns the customer's salutation. |
| secondName: String | Returns the customer's second name. |
| stateCode: String | Returns the customer's state. |
| suffix: String | Returns the customer's suffix. |
| suite: String | Returns the customer's suite. |
| title: String | Returns the customer's title. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getAddress1() | Returns the customer's first address. |
| getAddress2() | Returns the customer's second address. |
| getCity() | Returns the Customer's City. |
| getCompanyName() | Returns the Customer's company name. |
| getCountryCode() | Returns the customer's country code. |
| getFirstName() | Returns the Customer's first name. |
| getFullName() | Returns a concatenation of the Customer's first, middle, and last names and it' suffix. |
| getJobTitle() | Returns the customer's job title. |
| getLastName() | Returns the customer's last name. |
| getPhone() | Returns the customer's phone number. |
| getPostBox() | Returns the customer's post box. |
| getPostalCode() | Returns the customer's postal code. |
| getSalutation() | Returns the customer's salutation. |
| getSecondName() | Returns the customer's second name. |
| getStateCode() | Returns the customer's state. |
| getSuffix() | Returns the customer's suffix. |
| getSuite() | Returns the customer's suite. |
| getTitle() | Returns the customer's title. |
| isEquivalentAddress(Object) | Returns true if the specified address is equivalent to this address. |
| setAddress1(String) | Sets the customer's first address. |
| setAddress2(String) | Sets the customer's second address. |
| setCity(String) | Sets the Customer's City. |
| setCompanyName(String) | Sets the Customer's company name. |
| setCountryCode(String) | Sets the Customer's country code. |
| setFirstName(String) | Sets the Customer's first name. |
| setJobTitle(String) | Sets the customer's job title. |
| setLastName(String) | Sets the customer's last name. |
| setPhone(String) | Sets the customer's phone number. |
| setPostBox(String) | Sets the customer's post box. |
| setPostalCode(String) | Sets the customer's postal code. |
| Sets the customer's salutation. | |
| setSalutation(String) | Sets the customer's salutation. |
| setSecondName(String) | Sets the customer's second name. |
| setStateCode(String) | Sets the customer's state. |
| setSuffix(String) | Sets the customer's suffix. |
| setSuite(String) | Sets the customer's suite. |
| setTitle(String) | Sets the customer's title. |
getCreationDate, getLastModified, getUUID
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
- address1: String
Returns the customer's first address.
- address2: String
Returns the customer's second address.
- city: String
Returns the Customer's City.
- companyName: String
Returns the Customer's company name.
- countryCode: EnumValue
Returns the customer's country code.
- firstName: String
Returns the Customer's first name.
- fullName: String
(read-only) Returns a concatenation of the Customer's first, middle, and last names and it' suffix.
- jobTitle: String
Returns the customer's job title.
- lastName: String
Returns the customer's last name.
- phone: String
Returns the customer's phone number.
- postBox: String
Returns the customer's post box.
- postalCode: String
Returns the customer's postal code.
- salutation: String
Returns the customer's salutation.
- secondName: String
Returns the customer's second name.
- stateCode: String
Returns the customer's state.
- suffix: String
Returns the customer's suffix.
- suite: String
Returns the customer's suite.
- title: String
Returns the customer's title.
- getAddress1(): String
Returns the customer's first address.
Returns:
- the first address value.
- getAddress2(): String
Returns the customer's second address.
Returns:
- the second address value.
- getCity(): String
Returns the Customer's City.
Returns:
- the Customer's city.
- getCompanyName(): String
Returns the Customer's company name.
Returns:
- the company name.
- getCountryCode(): EnumValue
Returns the customer's country code.
Returns:
- the country code.
- getFirstName(): String
Returns the Customer's first name.
Returns:
- the Customer first name.
- getFullName(): String
Returns a concatenation of the Customer's first, middle, and last names and it' suffix.
Returns:
- a concatenation of the Customer's first, middle, and last names and it' suffix.
- getJobTitle(): String
Returns the customer's job title.
Returns:
- the job title.
- getLastName(): String
Returns the customer's last name.
Returns:
- the last name.
- getPhone(): String
Returns the customer's phone number.
Returns:
- the phone number.
- getPostBox(): String
Returns the customer's post box.
Returns:
- the postBox.
- getPostalCode(): String
Returns the customer's postal code.
Returns:
- the postal code.
- getSalutation(): String
Returns the customer's salutation.
Returns:
- the customer's salutation.
- getSecondName(): String
Returns the customer's second name.
Returns:
- the second name.
- getStateCode(): String
Returns the customer's state.
Returns:
- the state.
- getSuffix(): String
Returns the customer's suffix.
Returns:
- the suffix.
- getSuite(): String
Returns the customer's suite.
Returns:
- the customer's suite.
- getTitle(): String
Returns the customer's title.
Returns:
- the title.
- isEquivalentAddress(address: Object): Boolean
Returns true if the specified address is equivalent to this address. An equivalent address is an address whose core attributes contain the same values. The core attributes are:
- address1
- address2
- city
- companyName
- countryCode
- firstName
- lastName
- postalCode
- postBox
- stateCode
Parameters:
- address - the address to test.
Returns:
- true if the specified address is equivalent to this address, false otherwise.
- setAddress1(value: String): void
Sets the customer's first address.
Parameters:
- value - The value to set.
- setAddress2(value: String): void
Sets the customer's second address.
Parameters:
- value - The value to set.
- setCity(city: String): void
Sets the Customer's City.
Parameters:
- city - the Customer's city to set.
- setCompanyName(companyName: String): void
Sets the Customer's company name.
Parameters:
- companyName - the name of the company.
- setCountryCode(countryCode: String): void
Sets the Customer's country code.
Parameters:
- countryCode - the country code.
- setFirstName(firstName: String): void
Sets the Customer's first name.
Parameters:
- firstName - the customer's first name to set.
- setJobTitle(jobTitle: String): void
Sets the customer's job title.
Parameters:
- jobTitle - The job title to set.
- setLastName(lastName: String): void
Sets the customer's last name.
Parameters:
- lastName - The last name to set.
- setPhone(phoneNumber: String): void
Sets the customer's phone number. The length is restricted to 256 characters.
Parameters:
- phoneNumber - The phone number to set.
- setPostBox(postBox: String): void
Sets the customer's post box.
Parameters:
- postBox - The post box to set.
- setPostalCode(postalCode: String): void
Sets the customer's postal code.
Parameters:
- postalCode - The postal code to set.
setSaluation(value: String): voidSets the customer's salutation.
Parameters:
- value - the customer's salutation.
Deprecated:
- setSalutation(value: String): void
Sets the customer's salutation.
Parameters:
- value - the customer's salutation.
- setSecondName(secondName: String): void
Sets the customer's second name.
Parameters:
- secondName - The second name to set.
- setStateCode(state: String): void
Sets the customer's state.
Parameters:
- state - The state to set.
- setSuffix(suffix: String): void
Sets the customer's suffix.
Parameters:
- suffix - The suffix to set.
- setSuite(value: String): void
Sets the customer's suite. The length is restricted to 256 characters.
Parameters:
- value - the customer's suite.
- setTitle(title: String): void
Sets the customer's title.
Parameters:
- title - The title to set.