square-connect/src/model/BatchRetrieveOrdersRequest.js

JavaScript client library for the Square Connect v2 API

/**
 * Square Connect API
 * Client library for accessing the Square Connect APIs
 *
 * OpenAPI spec version: 2.0
 * Contact: developers@squareup.com
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 *
 * Swagger Codegen version: 2.3.0-SNAPSHOT
 *
 */
var ApiClient = require('../ApiClient');




/**
 * The BatchRetrieveOrdersRequest model module.
 * @module model/BatchRetrieveOrdersRequest
 */

/**
 * Constructs a new <code>BatchRetrieveOrdersRequest</code>.
 * Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.
 * @alias module:model/BatchRetrieveOrdersRequest
 * @class
 * @param orderIds {Array.<String>} The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request.
 */
var exports = function(orderIds) {
  var _this = this;


  _this['order_ids'] = orderIds;
};

/**
 * Constructs a <code>BatchRetrieveOrdersRequest</code> from a plain JavaScript object, optionally creating a new instance.
 * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
 * @param {Object} data The plain JavaScript object bearing properties of interest.
 * @param {module:model/BatchRetrieveOrdersRequest} obj Optional instance to populate.
 * @return {module:model/BatchRetrieveOrdersRequest} The populated <code>BatchRetrieveOrdersRequest</code> instance.
 */
exports.constructFromObject = function(data, obj) {
  if (data) {
    obj = obj || new exports();

      if (data.hasOwnProperty('location_id')) {
      obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String');
    }
      if (data.hasOwnProperty('order_ids')) {
      obj['order_ids'] = ApiClient.convertToType(data['order_ids'], ['String']);
    }
    }
  return obj;
}

/**
 * The ID of the location for these orders. This field is optional: omit it to retrieve orders within the scope of the current authorization's merchant ID.
 * @member {String} location_id
 */
exports.prototype['location_id'] = undefined;
/**
 * The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request.
 * @member {Array.<String>} order_ids
 */
exports.prototype['order_ids'] = undefined;



module.exports = exports;