@signalwire/compatibility-api
Version:
SignalWire Compatibility API
692 lines (621 loc) • 21.2 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 deserialize = require(
'../../../../base/deserialize'); /* jshint ignore:line */
var values = require('../../../../base/values'); /* jshint ignore:line */
var ShortCodeList;
var ShortCodePage;
var ShortCodeInstance;
var ShortCodeContext;
/* jshint ignore:start */
/**
* Initialize the ShortCodeList
*
* @constructor Twilio.Api.V2010.AccountContext.ShortCodeList
*
* @param {Twilio.Api.V2010} version - Version of the resource
* @param {string} accountSid - The SID of the Account that created this resource
*/
/* jshint ignore:end */
ShortCodeList = function ShortCodeList(version, accountSid) {
/* jshint ignore:start */
/**
* @function shortCodes
* @memberof Twilio.Api.V2010.AccountContext#
*
* @param {string} sid - sid of instance
*
* @returns {Twilio.Api.V2010.AccountContext.ShortCodeContext}
*/
/* jshint ignore:end */
function ShortCodeListInstance(sid) {
return ShortCodeListInstance.get(sid);
}
ShortCodeListInstance._version = version;
// Path Solution
ShortCodeListInstance._solution = {accountSid: accountSid};
ShortCodeListInstance._uri = `/Accounts/${accountSid}/SMS/ShortCodes.json`;
/* jshint ignore:start */
/**
* Streams ShortCodeInstance 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.Api.V2010.AccountContext.ShortCodeList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.friendlyName] -
* The string that identifies the ShortCode resources to read
* @param {string} [opts.shortCode] - Filter by ShortCode
* @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 */
ShortCodeListInstance.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 ShortCodeInstance 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.Api.V2010.AccountContext.ShortCodeList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.friendlyName] -
* The string that identifies the ShortCode resources to read
* @param {string} [opts.shortCode] - Filter by ShortCode
* @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 */
ShortCodeListInstance.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 ShortCodeInstance 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.Api.V2010.AccountContext.ShortCodeList#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.friendlyName] -
* The string that identifies the ShortCode resources to read
* @param {string} [opts.shortCode] - Filter by ShortCode
* @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 */
ShortCodeListInstance.page = function page(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'FriendlyName': _.get(opts, 'friendlyName'),
'ShortCode': _.get(opts, 'shortCode'),
'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 ShortCodePage(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 ShortCodeInstance 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.Api.V2010.AccountContext.ShortCodeList#
*
* @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 */
ShortCodeListInstance.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 ShortCodePage(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 short_code
*
* @function get
* @memberof Twilio.Api.V2010.AccountContext.ShortCodeList#
*
* @param {string} sid - The unique string that identifies this resource
*
* @returns {Twilio.Api.V2010.AccountContext.ShortCodeContext}
*/
/* jshint ignore:end */
ShortCodeListInstance.get = function get(sid) {
return new ShortCodeContext(this._version, this._solution.accountSid, sid);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.ShortCodeList#
*
* @returns Object
*/
/* jshint ignore:end */
ShortCodeListInstance.toJSON = function toJSON() {
return this._solution;
};
ShortCodeListInstance[util.inspect.custom] = function inspect(depth, options) {
return util.inspect(this.toJSON(), options);
};
return ShortCodeListInstance;
};
/* jshint ignore:start */
/**
* Initialize the ShortCodePage
*
* @constructor Twilio.Api.V2010.AccountContext.ShortCodePage
*
* @param {V2010} version - Version of the resource
* @param {Response<string>} response - Response from the API
* @param {ShortCodeSolution} solution - Path solution
*
* @returns ShortCodePage
*/
/* jshint ignore:end */
ShortCodePage = function ShortCodePage(version, response, solution) {
// Path Solution
this._solution = solution;
Page.prototype.constructor.call(this, version, response, this._solution);
};
_.extend(ShortCodePage.prototype, Page.prototype);
ShortCodePage.prototype.constructor = ShortCodePage;
/* jshint ignore:start */
/**
* Build an instance of ShortCodeInstance
*
* @function getInstance
* @memberof Twilio.Api.V2010.AccountContext.ShortCodePage#
*
* @param {ShortCodePayload} payload - Payload response from the API
*
* @returns ShortCodeInstance
*/
/* jshint ignore:end */
ShortCodePage.prototype.getInstance = function getInstance(payload) {
return new ShortCodeInstance(this._version, payload, this._solution.accountSid);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.ShortCodePage#
*
* @returns Object
*/
/* jshint ignore:end */
ShortCodePage.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
ShortCodePage.prototype[util.inspect.custom] = function inspect(depth, options)
{
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the ShortCodeContext
*
* @constructor Twilio.Api.V2010.AccountContext.ShortCodeInstance
*
* @property {string} accountSid -
* The SID of the Account that created this resource
* @property {string} apiVersion -
* The API version used to start a new TwiML session
* @property {Date} dateCreated -
* The RFC 2822 date and time in GMT that this resource was created
* @property {Date} dateUpdated -
* The RFC 2822 date and time in GMT that this resource was last updated
* @property {string} friendlyName -
* A string that you assigned to describe this resource
* @property {string} shortCode - The short code. e.g., 894546.
* @property {string} sid - The unique string that identifies this resource
* @property {string} smsFallbackMethod -
* HTTP method we use to call the sms_fallback_url
* @property {string} smsFallbackUrl -
* URL Twilio will request if an error occurs in executing TwiML
* @property {string} smsMethod - HTTP method to use when requesting the sms url
* @property {string} smsUrl -
* URL we call when receiving an incoming SMS message to this short code
* @property {string} uri -
* The URI of this resource, relative to `https://api.twilio.com`
*
* @param {V2010} version - Version of the resource
* @param {ShortCodePayload} payload - The instance payload
* @param {sid} accountSid - The SID of the Account that created this resource
* @param {sid} sid - The unique string that identifies this resource
*/
/* jshint ignore:end */
ShortCodeInstance = function ShortCodeInstance(version, payload, accountSid,
sid) {
this._version = version;
// Marshaled Properties
this.accountSid = payload.account_sid; // jshint ignore:line
this.apiVersion = payload.api_version; // jshint ignore:line
this.dateCreated = deserialize.rfc2822DateTime(payload.date_created); // jshint ignore:line
this.dateUpdated = deserialize.rfc2822DateTime(payload.date_updated); // jshint ignore:line
this.friendlyName = payload.friendly_name; // jshint ignore:line
this.shortCode = payload.short_code; // jshint ignore:line
this.sid = payload.sid; // 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.uri = payload.uri; // jshint ignore:line
// Context
this._context = undefined;
this._solution = {accountSid: accountSid, sid: sid || this.sid, };
};
Object.defineProperty(ShortCodeInstance.prototype,
'_proxy', {
get: function() {
if (!this._context) {
this._context = new ShortCodeContext(this._version, this._solution.accountSid, this._solution.sid);
}
return this._context;
}
});
/* jshint ignore:start */
/**
* fetch a ShortCodeInstance
*
* @function fetch
* @memberof Twilio.Api.V2010.AccountContext.ShortCodeInstance#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed ShortCodeInstance
*/
/* jshint ignore:end */
ShortCodeInstance.prototype.fetch = function fetch(callback) {
return this._proxy.fetch(callback);
};
/* jshint ignore:start */
/**
* update a ShortCodeInstance
*
* @function update
* @memberof Twilio.Api.V2010.AccountContext.ShortCodeInstance#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.friendlyName] - A string to describe this resource
* @param {string} [opts.apiVersion] -
* The API version to use to start a new TwiML session
* @param {string} [opts.smsUrl] - URL Twilio will request when receiving an SMS
* @param {string} [opts.smsMethod] -
* HTTP method to use when requesting the sms url
* @param {string} [opts.smsFallbackUrl] -
* URL Twilio will request if an error occurs in executing TwiML
* @param {string} [opts.smsFallbackMethod] -
* HTTP method Twilio will use with sms_fallback_url
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed ShortCodeInstance
*/
/* jshint ignore:end */
ShortCodeInstance.prototype.update = function update(opts, callback) {
return this._proxy.update(opts, callback);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.ShortCodeInstance#
*
* @returns Object
*/
/* jshint ignore:end */
ShortCodeInstance.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
ShortCodeInstance.prototype[util.inspect.custom] = function inspect(depth,
options) {
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the ShortCodeContext
*
* @constructor Twilio.Api.V2010.AccountContext.ShortCodeContext
*
* @param {V2010} version - Version of the resource
* @param {sid} accountSid -
* The SID of the Account that created the resource(s) to fetch
* @param {sid} sid - The unique string that identifies this resource
*/
/* jshint ignore:end */
ShortCodeContext = function ShortCodeContext(version, accountSid, sid) {
this._version = version;
// Path Solution
this._solution = {accountSid: accountSid, sid: sid, };
this._uri = `/Accounts/${accountSid}/SMS/ShortCodes/${sid}.json`;
};
/* jshint ignore:start */
/**
* fetch a ShortCodeInstance
*
* @function fetch
* @memberof Twilio.Api.V2010.AccountContext.ShortCodeContext#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed ShortCodeInstance
*/
/* jshint ignore:end */
ShortCodeContext.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 ShortCodeInstance(
this._version,
payload,
this._solution.accountSid,
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 ShortCodeInstance
*
* @function update
* @memberof Twilio.Api.V2010.AccountContext.ShortCodeContext#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.friendlyName] - A string to describe this resource
* @param {string} [opts.apiVersion] -
* The API version to use to start a new TwiML session
* @param {string} [opts.smsUrl] - URL Twilio will request when receiving an SMS
* @param {string} [opts.smsMethod] -
* HTTP method to use when requesting the sms url
* @param {string} [opts.smsFallbackUrl] -
* URL Twilio will request if an error occurs in executing TwiML
* @param {string} [opts.smsFallbackMethod] -
* HTTP method Twilio will use with sms_fallback_url
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed ShortCodeInstance
*/
/* jshint ignore:end */
ShortCodeContext.prototype.update = function update(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'FriendlyName': _.get(opts, 'friendlyName'),
'ApiVersion': _.get(opts, 'apiVersion'),
'SmsUrl': _.get(opts, 'smsUrl'),
'SmsMethod': _.get(opts, 'smsMethod'),
'SmsFallbackUrl': _.get(opts, 'smsFallbackUrl'),
'SmsFallbackMethod': _.get(opts, 'smsFallbackMethod')
});
var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
promise = promise.then(function(payload) {
deferred.resolve(new ShortCodeInstance(
this._version,
payload,
this._solution.accountSid,
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 */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.ShortCodeContext#
*
* @returns Object
*/
/* jshint ignore:end */
ShortCodeContext.prototype.toJSON = function toJSON() {
return this._solution;
};
ShortCodeContext.prototype[util.inspect.custom] = function inspect(depth,
options) {
return util.inspect(this.toJSON(), options);
};
module.exports = {
ShortCodeList: ShortCodeList,
ShortCodePage: ShortCodePage,
ShortCodeInstance: ShortCodeInstance,
ShortCodeContext: ShortCodeContext
};