square-connect
Version:
JavaScript client library for the Square Connect v2 API
75 lines (57 loc) • 2.28 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');
/**
* The CustomerSort model module.
* @module model/CustomerSort
*/
/**
* Constructs a new <code>CustomerSort</code>.
* Specifies how searched customers profiles are sorted, including the sort key and sort order.
* @alias module:model/CustomerSort
* @class
*/
var exports = function() {
var _this = this;
};
/**
* Constructs a <code>CustomerSort</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/CustomerSort} obj Optional instance to populate.
* @return {module:model/CustomerSort} The populated <code>CustomerSort</code> instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
if (data.hasOwnProperty('field')) {
obj['field'] = ApiClient.convertToType(data['field'], 'String');
}
if (data.hasOwnProperty('order')) {
obj['order'] = ApiClient.convertToType(data['order'], 'String');
}
}
return obj;
}
/**
* Use one or more customer attributes as the sort key to sort searched customer profiles. For example, use creation date (`created_at`) of customers or default attributes as the sort key. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values
* @member {String} field
*/
exports.prototype['field'] = undefined;
/**
* Indicates the order in which results should be sorted based on the sort field value. Strings use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values
* @member {String} order
*/
exports.prototype['order'] = undefined;
module.exports = exports;