square-connect
Version:
JavaScript client library for the Square Connect v2 API
87 lines (68 loc) • 2.67 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 Error = require('./Error');
var Subscription = require('./Subscription');
/**
* The SearchSubscriptionsResponse model module.
* Note: This model is in beta.
* @module model/SearchSubscriptionsResponse
*/
/**
* Constructs a new <code>SearchSubscriptionsResponse</code>.
* Defines the fields that are included in the response from the [SearchSubscriptions](#endpoint-subscriptions-searchsubscriptions) endpoint.
* @alias module:model/SearchSubscriptionsResponse
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>SearchSubscriptionsResponse</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/SearchSubscriptionsResponse} obj Optional instance to populate.
* @return {module:model/SearchSubscriptionsResponse} The populated <code>SearchSubscriptionsResponse</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('subscriptions')) {
obj['subscriptions'] = ApiClient.convertToType(data['subscriptions'], [Subscription]);
}
if (data.hasOwnProperty('cursor')) {
obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
}
}
return obj;
}
/**
* Information about errors encountered during the request.
* @member {Array.<module:model/Error>} errors
*/
exports.prototype['errors'] = undefined;
/**
* The search result.
* @member {Array.<module:model/Subscription>} subscriptions
*/
exports.prototype['subscriptions'] = undefined;
/**
* When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of subscriptions. If empty, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination).
* @member {String} cursor
*/
exports.prototype['cursor'] = undefined;
module.exports = exports;