square-connect
Version:
JavaScript client library for the Square Connect v2 API
86 lines (67 loc) • 2.63 kB
JavaScript
/**
* 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');
var Customer = require('./Customer');
var Error = require('./Error');
/**
* The ListCustomersResponse model module.
* @module model/ListCustomersResponse
*/
/**
* Constructs a new <code>ListCustomersResponse</code>.
* Defines the fields that are included in the response body of a request to the ListCustomers endpoint. One of `errors` or `customers` is present in a given response (never both).
* @alias module:model/ListCustomersResponse
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>ListCustomersResponse</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/ListCustomersResponse} obj Optional instance to populate.
* @return {module:model/ListCustomersResponse} The populated <code>ListCustomersResponse</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('errors')) {
obj['errors'] = ApiClient.convertToType(data['errors'], [Error]);
}
if (data.hasOwnProperty('customers')) {
obj['customers'] = ApiClient.convertToType(data['customers'], [Customer]);
}
if (data.hasOwnProperty('cursor')) {
obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
}
}
return obj;
}
/**
* Any errors that occurred during the request.
* @member {Array.<module:model/Error>} errors
*/
exports.prototype['errors'] = undefined;
/**
* An array of `Customer` objects that match the provided query.
* @member {Array.<module:model/Customer>} customers
*/
exports.prototype['customers'] = undefined;
/**
* A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the [Pagination guide](https://developer.squareup.com/docs/working-with-apis/pagination) for more information.
* @member {String} cursor
*/
exports.prototype['cursor'] = undefined;
module.exports = exports;