@signalwire/compatibility-api
Version:
SignalWire Compatibility API
762 lines (688 loc) • 23.5 kB
JavaScript
'use strict';
/* jshint ignore:start */
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
/* jshint ignore:end */
var Q = require('q'); /* jshint ignore:line */
var _ = require('lodash'); /* jshint ignore:line */
var util = require('util'); /* jshint ignore:line */
var Page = require('../../../base/Page'); /* jshint ignore:line */
var UsageList = require('./sim/usage').UsageList;
var deserialize = require(
'../../../base/deserialize'); /* jshint ignore:line */
var values = require('../../../base/values'); /* jshint ignore:line */
var SimList;
var SimPage;
var SimInstance;
var SimContext;
/* jshint ignore:start */
/**
* Initialize the SimList
*
* PLEASE NOTE that this class contains preview products that are subject to
* change. Use them with caution. If you currently do not have developer preview
* access, please contact help@twilio.com.
*
* @constructor Twilio.Preview.Wireless.SimList
*
* @param {Twilio.Preview.Wireless} version - Version of the resource
*/
/* jshint ignore:end */
SimList = function SimList(version) {
/* jshint ignore:start */
/**
* @function sims
* @memberof Twilio.Preview.Wireless#
*
* @param {string} sid - sid of instance
*
* @returns {Twilio.Preview.Wireless.SimContext}
*/
/* jshint ignore:end */
function SimListInstance(sid) {
return SimListInstance.get(sid);
}
SimListInstance._version = version;
// Path Solution
SimListInstance._solution = {};
SimListInstance._uri = `/Sims`;
/* jshint ignore:start */
/**
* Streams SimInstance records from the API.
*
* This operation lazily loads records as efficiently as possible until the limit
* is reached.
*
* The results are passed into the callback function, so this operation is memory
* efficient.
*
* If a function is passed as the first argument, it will be used as the callback
* function.
*
* @function each
* @memberof Twilio.Preview.Wireless.SimList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.status] - The status
* @param {string} [opts.iccid] - The iccid
* @param {string} [opts.ratePlan] - The rate_plan
* @param {string} [opts.eId] - The e_id
* @param {string} [opts.simRegistrationCode] - The sim_registration_code
* @param {number} [opts.limit] -
* Upper limit for the number of records to return.
* each() guarantees never to return more than limit.
* Default is no limit
* @param {number} [opts.pageSize] -
* Number of records to fetch per request,
* when not set will use the default value of 50 records.
* If no pageSize is defined but a limit is defined,
* each() will attempt to read the limit with the most efficient
* page size, i.e. min(limit, 1000)
* @param {Function} [opts.callback] -
* Function to process each record. If this and a positional
* callback are passed, this one will be used
* @param {Function} [opts.done] -
* Function to be called upon completion of streaming
* @param {Function} [callback] - Function to process each record
*/
/* jshint ignore:end */
SimListInstance.each = function each(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
if (opts.callback) {
callback = opts.callback;
}
if (_.isUndefined(callback)) {
throw new Error('Callback function must be provided');
}
var done = false;
var currentPage = 1;
var currentResource = 0;
var limits = this._version.readLimits({
limit: opts.limit,
pageSize: opts.pageSize
});
function onComplete(error) {
done = true;
if (_.isFunction(opts.done)) {
opts.done(error);
}
}
function fetchNextPage(fn) {
var promise = fn();
if (_.isUndefined(promise)) {
onComplete();
return;
}
promise.then(function(page) {
_.each(page.instances, function(instance) {
if (done || (!_.isUndefined(opts.limit) && currentResource >= opts.limit)) {
done = true;
return false;
}
currentResource++;
callback(instance, onComplete);
});
if (!done) {
currentPage++;
fetchNextPage(_.bind(page.nextPage, page));
} else {
onComplete();
}
});
promise.catch(onComplete);
}
fetchNextPage(_.bind(this.page, this, _.merge(opts, limits)));
};
/* jshint ignore:start */
/**
* Lists SimInstance records from the API as a list.
*
* If a function is passed as the first argument, it will be used as the callback
* function.
*
* @function list
* @memberof Twilio.Preview.Wireless.SimList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.status] - The status
* @param {string} [opts.iccid] - The iccid
* @param {string} [opts.ratePlan] - The rate_plan
* @param {string} [opts.eId] - The e_id
* @param {string} [opts.simRegistrationCode] - The sim_registration_code
* @param {number} [opts.limit] -
* Upper limit for the number of records to return.
* list() guarantees never to return more than limit.
* Default is no limit
* @param {number} [opts.pageSize] -
* Number of records to fetch per request,
* when not set will use the default value of 50 records.
* If no page_size is defined but a limit is defined,
* list() will attempt to read the limit with the most
* efficient page size, i.e. min(limit, 1000)
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
SimListInstance.list = function list(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var allResources = [];
opts.callback = function(resource, done) {
allResources.push(resource);
if (!_.isUndefined(opts.limit) && allResources.length === opts.limit) {
done();
}
};
opts.done = function(error) {
if (_.isUndefined(error)) {
deferred.resolve(allResources);
} else {
deferred.reject(error);
}
};
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
this.each(opts);
return deferred.promise;
};
/* jshint ignore:start */
/**
* Retrieve a single page of SimInstance records from the API.
*
* The request is executed immediately.
*
* If a function is passed as the first argument, it will be used as the callback
* function.
*
* @function page
* @memberof Twilio.Preview.Wireless.SimList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.status] - The status
* @param {string} [opts.iccid] - The iccid
* @param {string} [opts.ratePlan] - The rate_plan
* @param {string} [opts.eId] - The e_id
* @param {string} [opts.simRegistrationCode] - The sim_registration_code
* @param {string} [opts.pageToken] - PageToken provided by the API
* @param {number} [opts.pageNumber] -
* Page Number, this value is simply for client state
* @param {number} [opts.pageSize] - Number of records to return, defaults to 50
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
SimListInstance.page = function page(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'Status': _.get(opts, 'status'),
'Iccid': _.get(opts, 'iccid'),
'RatePlan': _.get(opts, 'ratePlan'),
'EId': _.get(opts, 'eId'),
'SimRegistrationCode': _.get(opts, 'simRegistrationCode'),
'PageToken': opts.pageToken,
'Page': opts.pageNumber,
'PageSize': opts.pageSize
});
var promise = this._version.page({uri: this._uri, method: 'GET', params: data});
promise = promise.then(function(payload) {
deferred.resolve(new SimPage(this._version, payload, this._solution));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* Retrieve a single target page of SimInstance records from the API.
*
* The request is executed immediately.
*
* If a function is passed as the first argument, it will be used as the callback
* function.
*
* @function getPage
* @memberof Twilio.Preview.Wireless.SimList#
*
* @param {string} [targetUrl] - API-generated URL for the requested results page
* @param {function} [callback] - Callback to handle list of records
*
* @returns {Promise} Resolves to a list of records
*/
/* jshint ignore:end */
SimListInstance.getPage = function getPage(targetUrl, callback) {
var deferred = Q.defer();
var promise = this._version._domain.twilio.request({method: 'GET', uri: targetUrl});
promise = promise.then(function(payload) {
deferred.resolve(new SimPage(this._version, payload, this._solution));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* Constructs a sim
*
* @function get
* @memberof Twilio.Preview.Wireless.SimList#
*
* @param {string} sid - The sid
*
* @returns {Twilio.Preview.Wireless.SimContext}
*/
/* jshint ignore:end */
SimListInstance.get = function get(sid) {
return new SimContext(this._version, sid);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Preview.Wireless.SimList#
*
* @returns Object
*/
/* jshint ignore:end */
SimListInstance.toJSON = function toJSON() {
return this._solution;
};
SimListInstance[util.inspect.custom] = function inspect(depth, options) {
return util.inspect(this.toJSON(), options);
};
return SimListInstance;
};
/* jshint ignore:start */
/**
* Initialize the SimPage
*
* PLEASE NOTE that this class contains preview products that are subject to
* change. Use them with caution. If you currently do not have developer preview
* access, please contact help@twilio.com.
*
* @constructor Twilio.Preview.Wireless.SimPage
*
* @param {Wireless} version - Version of the resource
* @param {Response<string>} response - Response from the API
* @param {SimSolution} solution - Path solution
*
* @returns SimPage
*/
/* jshint ignore:end */
SimPage = function SimPage(version, response, solution) {
// Path Solution
this._solution = solution;
Page.prototype.constructor.call(this, version, response, this._solution);
};
_.extend(SimPage.prototype, Page.prototype);
SimPage.prototype.constructor = SimPage;
/* jshint ignore:start */
/**
* Build an instance of SimInstance
*
* @function getInstance
* @memberof Twilio.Preview.Wireless.SimPage#
*
* @param {SimPayload} payload - Payload response from the API
*
* @returns SimInstance
*/
/* jshint ignore:end */
SimPage.prototype.getInstance = function getInstance(payload) {
return new SimInstance(this._version, payload);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Preview.Wireless.SimPage#
*
* @returns Object
*/
/* jshint ignore:end */
SimPage.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
SimPage.prototype[util.inspect.custom] = function inspect(depth, options) {
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the SimContext
*
* PLEASE NOTE that this class contains preview products that are subject to
* change. Use them with caution. If you currently do not have developer preview
* access, please contact help@twilio.com.
*
* @constructor Twilio.Preview.Wireless.SimInstance
*
* @property {string} sid - The sid
* @property {string} uniqueName - The unique_name
* @property {string} accountSid - The account_sid
* @property {string} ratePlanSid - The rate_plan_sid
* @property {string} friendlyName - The friendly_name
* @property {string} iccid - The iccid
* @property {string} eId - The e_id
* @property {string} status - The status
* @property {string} commandsCallbackUrl - The commands_callback_url
* @property {string} commandsCallbackMethod - The commands_callback_method
* @property {string} smsFallbackMethod - The sms_fallback_method
* @property {string} smsFallbackUrl - The sms_fallback_url
* @property {string} smsMethod - The sms_method
* @property {string} smsUrl - The sms_url
* @property {string} voiceFallbackMethod - The voice_fallback_method
* @property {string} voiceFallbackUrl - The voice_fallback_url
* @property {string} voiceMethod - The voice_method
* @property {string} voiceUrl - The voice_url
* @property {Date} dateCreated - The date_created
* @property {Date} dateUpdated - The date_updated
* @property {string} url - The url
* @property {string} links - The links
*
* @param {Wireless} version - Version of the resource
* @param {SimPayload} payload - The instance payload
* @param {sid_like} sid - The sid
*/
/* jshint ignore:end */
SimInstance = function SimInstance(version, payload, sid) {
this._version = version;
// Marshaled Properties
this.sid = payload.sid; // jshint ignore:line
this.uniqueName = payload.unique_name; // jshint ignore:line
this.accountSid = payload.account_sid; // jshint ignore:line
this.ratePlanSid = payload.rate_plan_sid; // jshint ignore:line
this.friendlyName = payload.friendly_name; // jshint ignore:line
this.iccid = payload.iccid; // jshint ignore:line
this.eId = payload.e_id; // jshint ignore:line
this.status = payload.status; // jshint ignore:line
this.commandsCallbackUrl = payload.commands_callback_url; // jshint ignore:line
this.commandsCallbackMethod = payload.commands_callback_method; // jshint ignore:line
this.smsFallbackMethod = payload.sms_fallback_method; // jshint ignore:line
this.smsFallbackUrl = payload.sms_fallback_url; // jshint ignore:line
this.smsMethod = payload.sms_method; // jshint ignore:line
this.smsUrl = payload.sms_url; // jshint ignore:line
this.voiceFallbackMethod = payload.voice_fallback_method; // jshint ignore:line
this.voiceFallbackUrl = payload.voice_fallback_url; // jshint ignore:line
this.voiceMethod = payload.voice_method; // jshint ignore:line
this.voiceUrl = payload.voice_url; // jshint ignore:line
this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
this.url = payload.url; // jshint ignore:line
this.links = payload.links; // jshint ignore:line
// Context
this._context = undefined;
this._solution = {sid: sid || this.sid, };
};
Object.defineProperty(SimInstance.prototype,
'_proxy', {
get: function() {
if (!this._context) {
this._context = new SimContext(this._version, this._solution.sid);
}
return this._context;
}
});
/* jshint ignore:start */
/**
* fetch a SimInstance
*
* @function fetch
* @memberof Twilio.Preview.Wireless.SimInstance#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed SimInstance
*/
/* jshint ignore:end */
SimInstance.prototype.fetch = function fetch(callback) {
return this._proxy.fetch(callback);
};
/* jshint ignore:start */
/**
* update a SimInstance
*
* @function update
* @memberof Twilio.Preview.Wireless.SimInstance#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.uniqueName] - The unique_name
* @param {string} [opts.callbackMethod] - The callback_method
* @param {string} [opts.callbackUrl] - The callback_url
* @param {string} [opts.friendlyName] - The friendly_name
* @param {string} [opts.ratePlan] - The rate_plan
* @param {string} [opts.status] - The status
* @param {string} [opts.commandsCallbackMethod] - The commands_callback_method
* @param {string} [opts.commandsCallbackUrl] - The commands_callback_url
* @param {string} [opts.smsFallbackMethod] - The sms_fallback_method
* @param {string} [opts.smsFallbackUrl] - The sms_fallback_url
* @param {string} [opts.smsMethod] - The sms_method
* @param {string} [opts.smsUrl] - The sms_url
* @param {string} [opts.voiceFallbackMethod] - The voice_fallback_method
* @param {string} [opts.voiceFallbackUrl] - The voice_fallback_url
* @param {string} [opts.voiceMethod] - The voice_method
* @param {string} [opts.voiceUrl] - The voice_url
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed SimInstance
*/
/* jshint ignore:end */
SimInstance.prototype.update = function update(opts, callback) {
return this._proxy.update(opts, callback);
};
/* jshint ignore:start */
/**
* Access the usage
*
* @function usage
* @memberof Twilio.Preview.Wireless.SimInstance#
*
* @returns {Twilio.Preview.Wireless.SimContext.UsageList}
*/
/* jshint ignore:end */
SimInstance.prototype.usage = function usage() {
return this._proxy.usage;
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Preview.Wireless.SimInstance#
*
* @returns Object
*/
/* jshint ignore:end */
SimInstance.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
SimInstance.prototype[util.inspect.custom] = function inspect(depth, options) {
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the SimContext
*
* PLEASE NOTE that this class contains preview products that are subject to
* change. Use them with caution. If you currently do not have developer preview
* access, please contact help@twilio.com.
*
* @constructor Twilio.Preview.Wireless.SimContext
*
* @property {Twilio.Preview.Wireless.SimContext.UsageList} usage - usage resource
*
* @param {Wireless} version - Version of the resource
* @param {sid_like} sid - The sid
*/
/* jshint ignore:end */
SimContext = function SimContext(version, sid) {
this._version = version;
// Path Solution
this._solution = {sid: sid, };
this._uri = `/Sims/${sid}`;
// Dependents
this._usage = undefined;
};
/* jshint ignore:start */
/**
* fetch a SimInstance
*
* @function fetch
* @memberof Twilio.Preview.Wireless.SimContext#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed SimInstance
*/
/* jshint ignore:end */
SimContext.prototype.fetch = function fetch(callback) {
var deferred = Q.defer();
var promise = this._version.fetch({uri: this._uri, method: 'GET'});
promise = promise.then(function(payload) {
deferred.resolve(new SimInstance(this._version, payload, this._solution.sid));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
/* jshint ignore:start */
/**
* update a SimInstance
*
* @function update
* @memberof Twilio.Preview.Wireless.SimContext#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.uniqueName] - The unique_name
* @param {string} [opts.callbackMethod] - The callback_method
* @param {string} [opts.callbackUrl] - The callback_url
* @param {string} [opts.friendlyName] - The friendly_name
* @param {string} [opts.ratePlan] - The rate_plan
* @param {string} [opts.status] - The status
* @param {string} [opts.commandsCallbackMethod] - The commands_callback_method
* @param {string} [opts.commandsCallbackUrl] - The commands_callback_url
* @param {string} [opts.smsFallbackMethod] - The sms_fallback_method
* @param {string} [opts.smsFallbackUrl] - The sms_fallback_url
* @param {string} [opts.smsMethod] - The sms_method
* @param {string} [opts.smsUrl] - The sms_url
* @param {string} [opts.voiceFallbackMethod] - The voice_fallback_method
* @param {string} [opts.voiceFallbackUrl] - The voice_fallback_url
* @param {string} [opts.voiceMethod] - The voice_method
* @param {string} [opts.voiceUrl] - The voice_url
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed SimInstance
*/
/* jshint ignore:end */
SimContext.prototype.update = function update(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'UniqueName': _.get(opts, 'uniqueName'),
'CallbackMethod': _.get(opts, 'callbackMethod'),
'CallbackUrl': _.get(opts, 'callbackUrl'),
'FriendlyName': _.get(opts, 'friendlyName'),
'RatePlan': _.get(opts, 'ratePlan'),
'Status': _.get(opts, 'status'),
'CommandsCallbackMethod': _.get(opts, 'commandsCallbackMethod'),
'CommandsCallbackUrl': _.get(opts, 'commandsCallbackUrl'),
'SmsFallbackMethod': _.get(opts, 'smsFallbackMethod'),
'SmsFallbackUrl': _.get(opts, 'smsFallbackUrl'),
'SmsMethod': _.get(opts, 'smsMethod'),
'SmsUrl': _.get(opts, 'smsUrl'),
'VoiceFallbackMethod': _.get(opts, 'voiceFallbackMethod'),
'VoiceFallbackUrl': _.get(opts, 'voiceFallbackUrl'),
'VoiceMethod': _.get(opts, 'voiceMethod'),
'VoiceUrl': _.get(opts, 'voiceUrl')
});
var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
promise = promise.then(function(payload) {
deferred.resolve(new SimInstance(this._version, payload, this._solution.sid));
}.bind(this));
promise.catch(function(error) {
deferred.reject(error);
});
if (_.isFunction(callback)) {
deferred.promise.nodeify(callback);
}
return deferred.promise;
};
Object.defineProperty(SimContext.prototype,
'usage', {
get: function() {
if (!this._usage) {
this._usage = new UsageList(this._version, this._solution.sid);
}
return this._usage;
}
});
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Preview.Wireless.SimContext#
*
* @returns Object
*/
/* jshint ignore:end */
SimContext.prototype.toJSON = function toJSON() {
return this._solution;
};
SimContext.prototype[util.inspect.custom] = function inspect(depth, options) {
return util.inspect(this.toJSON(), options);
};
module.exports = {
SimList: SimList,
SimPage: SimPage,
SimInstance: SimInstance,
SimContext: SimContext
};