new module:models/CustomerProductList()
Constructs a new CustomerProductList.
Document representing a customer product List.
- Source:
Members
(readonly) TypeEnum :String
Allowed values for the type property.
Type:
- String
- Source:
(inner) co_registrant :module:models/CustomerProductListRegistrant
The coRegistrant of this product list.
Type:
- Source:
(inner) creation_date :Date
Returns the value of attribute 'creationDate'.
Type:
- Date
- Source:
(inner) current_shipping_address_link :module:models/CustomerAddressLink
The resource link to the current shipping address of this customer product list.
Type:
- Source:
(inner, constant) custom_1
value: "custom_1"
- Source:
(inner, constant) custom_2
value: "custom_2"
- Source:
(inner, constant) custom_3
value: "custom_3"
- Source:
(inner) customer_product_list_items :Array.<module:models/CustomerProductListItem>
The list of customer product list items.
Type:
- Source:
(inner) description :String
The description of this product list.
Type:
- String
- Source:
(inner) event :module:models/ProductListEvent
The event of this product list.
Type:
- Source:
(inner, constant) gift_registry
value: "gift_registry"
- Source:
(inner) id :String
The id of this product list.
Type:
- String
- Source:
(inner) items_link :module:models/CustomerProductListItemLink
The resource link to the items of this customer product list.
Type:
- Source:
(inner) last_modified :Date
Returns the value of attribute 'lastModified'.
Type:
- Date
- Source:
(inner) name :String
The name of this product list.
Type:
- String
- Source:
(inner) post_event_shipping_address_link :module:models/CustomerAddressLink
The resource link to the post event shipping address of this customer product list.
Type:
- Source:
(inner) product_list_shipping_address :module:models/ProductListShippingAddress
The abbreviated shipping address of this product list representing what anonymous user can see.
Type:
- Source:
(inner) public :Boolean
Indicates whether the owner made this product list available for access by other customers.
Type:
- Boolean
- Source:
(inner) registrant :module:models/CustomerProductListRegistrant
The registrant of this product list.
Type:
- Source:
(inner) shipping_address_link :module:models/CustomerAddressLink
The resource link to the shipping address of this customer product list.
Type:
- Source:
(inner, constant) shopping_list
value: "shopping_list"
- Source:
(inner) type :module:models/CustomerProductList.TypeEnum
The type of the product list.
Type:
- module:models/CustomerProductList.TypeEnum
- Source:
(inner, constant) wish_list
value: "wish_list"
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/CustomerProductList}
Constructs a CustomerProductList 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/CustomerProductList | Optional instance to populate. |
- Source:
Returns:
The populated CustomerProductList instance.