module:model/BulkRecipientsResponse

module:model/BulkRecipientsResponse

new module:model/BulkRecipientsResponse()

Source:

Constructs a new BulkRecipientsResponse.

Members

(inner) bulkRecipients :Array.<module:model/BulkRecipient>

Source:

A complex type containing information about the bulk recipients in the response.

Type:

(inner) endPosition :String

Source:

The last position in the result set.

Type:
  • String

(inner) nextUri :String

Source:

The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.

Type:
  • String

(inner) previousUri :String

Source:

The postal code for the billing address.

Type:
  • String

(inner) resultSetSize :String

Source:

The number of results returned in this response.

Type:
  • String

(inner) startPosition :String

Source:

Starting position of the current result set.

Type:
  • String

(inner) totalSetSize :String

Source:

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.

Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/BulkRecipientsResponse}

Source:

Constructs a BulkRecipientsResponse 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:model/BulkRecipientsResponse

Optional instance to populate.

Returns:

The populated BulkRecipientsResponse instance.

Type
module:model/BulkRecipientsResponse