Class: module:models/CustomerOrderResult

module:models/CustomerOrderResult()

new module:models/CustomerOrderResult()

Constructs a new CustomerOrderResult. Result document containing an array of customer orders.

Source:

Members

(inner) count :Number

The number of returned documents.

Type:
  • Number
Source:

(inner) data :Array.<module:models/Order>

The array of customer order documents.

Type:
Source:

(inner) next :String

The URL of the next result page.

Type:
  • String
Source:

(inner) previous :String

The URL of the previous result page.

Type:
  • String
Source:

(inner) select :String

The fields that you want to select.

Type:
  • String
Source:

(inner) start :Number

The zero-based index of the first search hit to include in the result.

Type:
  • Number
Source:

(inner) total :Number

The total number of documents.

Type:
  • Number
Source:

Methods

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

Constructs a CustomerOrderResult 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/CustomerOrderResult

Optional instance to populate.

Source:
Returns:

The populated CustomerOrderResult instance.

Type
module:models/CustomerOrderResult