@signalwire/compatibility-api
Version:
SignalWire Compatibility API
804 lines (720 loc) • 25.8 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 IpAddressList;
var IpAddressPage;
var IpAddressInstance;
var IpAddressContext;
/* jshint ignore:start */
/**
* Initialize the IpAddressList
*
* @constructor Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressList
*
* @param {Twilio.Api.V2010} version - Version of the resource
* @param {string} accountSid -
* The unique id of the Account that is responsible for this resource.
* @param {string} ipAccessControlListSid -
* The unique id of the IpAccessControlList resource that includes this resource.
*/
/* jshint ignore:end */
IpAddressList = function IpAddressList(version, accountSid,
ipAccessControlListSid) {
/* jshint ignore:start */
/**
* @function ipAddresses
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext#
*
* @param {string} sid - sid of instance
*
* @returns {Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressContext}
*/
/* jshint ignore:end */
function IpAddressListInstance(sid) {
return IpAddressListInstance.get(sid);
}
IpAddressListInstance._version = version;
// Path Solution
IpAddressListInstance._solution = {
accountSid: accountSid,
ipAccessControlListSid: ipAccessControlListSid
};
IpAddressListInstance._uri = `/Accounts/${accountSid}/SIP/IpAccessControlLists/${ipAccessControlListSid}/IpAddresses.json`;
/* jshint ignore:start */
/**
* Streams IpAddressInstance 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.SipContext.IpAccessControlListContext.IpAddressList#
*
* @param {object} [opts] - Options for request
* @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 */
IpAddressListInstance.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 IpAddressInstance 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.SipContext.IpAccessControlListContext.IpAddressList#
*
* @param {object} [opts] - Options for request
* @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 */
IpAddressListInstance.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 IpAddressInstance 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.SipContext.IpAccessControlListContext.IpAddressList#
*
* @param {object} [opts] - Options for request
* @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 */
IpAddressListInstance.page = function page(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'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 IpAddressPage(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 IpAddressInstance 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.SipContext.IpAccessControlListContext.IpAddressList#
*
* @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 */
IpAddressListInstance.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 IpAddressPage(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 */
/**
* create a IpAddressInstance
*
* @function create
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressList#
*
* @param {object} opts - Options for request
* @param {string} opts.friendlyName -
* A human readable descriptive text for this resource, up to 64 characters long.
* @param {string} opts.ipAddress -
* An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
* @param {number} [opts.cidrPrefixLength] -
* An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed IpAddressInstance
*/
/* jshint ignore:end */
IpAddressListInstance.create = function create(opts, callback) {
if (_.isUndefined(opts)) {
throw new Error('Required parameter "opts" missing.');
}
if (_.isUndefined(opts['friendlyName'])) {
throw new Error('Required parameter "opts[\'friendlyName\']" missing.');
}
if (_.isUndefined(opts['ipAddress'])) {
throw new Error('Required parameter "opts[\'ipAddress\']" missing.');
}
var deferred = Q.defer();
var data = values.of({
'FriendlyName': _.get(opts, 'friendlyName'),
'IpAddress': _.get(opts, 'ipAddress'),
'CidrPrefixLength': _.get(opts, 'cidrPrefixLength')
});
var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
promise = promise.then(function(payload) {
deferred.resolve(new IpAddressInstance(
this._version,
payload,
this._solution.accountSid,
this._solution.ipAccessControlListSid,
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 */
/**
* Constructs a ip_address
*
* @function get
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressList#
*
* @param {string} sid - A string that identifies the IpAddress resource to fetch
*
* @returns {Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressContext}
*/
/* jshint ignore:end */
IpAddressListInstance.get = function get(sid) {
return new IpAddressContext(
this._version,
this._solution.accountSid,
this._solution.ipAccessControlListSid,
sid
);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressList#
*
* @returns Object
*/
/* jshint ignore:end */
IpAddressListInstance.toJSON = function toJSON() {
return this._solution;
};
IpAddressListInstance[util.inspect.custom] = function inspect(depth, options) {
return util.inspect(this.toJSON(), options);
};
return IpAddressListInstance;
};
/* jshint ignore:start */
/**
* Initialize the IpAddressPage
*
* @constructor Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressPage
*
* @param {V2010} version - Version of the resource
* @param {Response<string>} response - Response from the API
* @param {IpAddressSolution} solution - Path solution
*
* @returns IpAddressPage
*/
/* jshint ignore:end */
IpAddressPage = function IpAddressPage(version, response, solution) {
// Path Solution
this._solution = solution;
Page.prototype.constructor.call(this, version, response, this._solution);
};
_.extend(IpAddressPage.prototype, Page.prototype);
IpAddressPage.prototype.constructor = IpAddressPage;
/* jshint ignore:start */
/**
* Build an instance of IpAddressInstance
*
* @function getInstance
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressPage#
*
* @param {IpAddressPayload} payload - Payload response from the API
*
* @returns IpAddressInstance
*/
/* jshint ignore:end */
IpAddressPage.prototype.getInstance = function getInstance(payload) {
return new IpAddressInstance(
this._version,
payload,
this._solution.accountSid,
this._solution.ipAccessControlListSid
);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressPage#
*
* @returns Object
*/
/* jshint ignore:end */
IpAddressPage.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
IpAddressPage.prototype[util.inspect.custom] = function inspect(depth, options)
{
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the IpAddressContext
*
* @constructor Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressInstance
*
* @property {string} sid -
* A 34 character string that uniquely identifies this resource.
* @property {string} accountSid -
* The unique id of the Account that is responsible for this resource.
* @property {string} friendlyName -
* A human readable descriptive text for this resource, up to 64 characters long.
* @property {string} ipAddress -
* An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
* @property {number} cidrPrefixLength -
* An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
* @property {string} ipAccessControlListSid -
* The unique id of the IpAccessControlList resource that includes this resource.
* @property {Date} dateCreated -
* The date that this resource was created, given as GMT in RFC 2822 format.
* @property {Date} dateUpdated -
* The date that this resource was last updated, given as GMT in RFC 2822 format.
* @property {string} uri -
* The URI for this resource, relative to https://api.twilio.com
*
* @param {V2010} version - Version of the resource
* @param {IpAddressPayload} payload - The instance payload
* @param {sid} accountSid -
* The unique id of the Account that is responsible for this resource.
* @param {sid} ipAccessControlListSid -
* The unique id of the IpAccessControlList resource that includes this resource.
* @param {sid} sid - A string that identifies the IpAddress resource to fetch
*/
/* jshint ignore:end */
IpAddressInstance = function IpAddressInstance(version, payload, accountSid,
ipAccessControlListSid, sid) {
this._version = version;
// Marshaled Properties
this.sid = payload.sid; // jshint ignore:line
this.accountSid = payload.account_sid; // jshint ignore:line
this.friendlyName = payload.friendly_name; // jshint ignore:line
this.ipAddress = payload.ip_address; // jshint ignore:line
this.cidrPrefixLength = deserialize.integer(payload.cidr_prefix_length); // jshint ignore:line
this.ipAccessControlListSid = payload.ip_access_control_list_sid; // jshint ignore:line
this.dateCreated = deserialize.rfc2822DateTime(payload.date_created); // jshint ignore:line
this.dateUpdated = deserialize.rfc2822DateTime(payload.date_updated); // jshint ignore:line
this.uri = payload.uri; // jshint ignore:line
// Context
this._context = undefined;
this._solution = {
accountSid: accountSid,
ipAccessControlListSid: ipAccessControlListSid,
sid: sid || this.sid,
};
};
Object.defineProperty(IpAddressInstance.prototype,
'_proxy', {
get: function() {
if (!this._context) {
this._context = new IpAddressContext(
this._version,
this._solution.accountSid,
this._solution.ipAccessControlListSid,
this._solution.sid
);
}
return this._context;
}
});
/* jshint ignore:start */
/**
* fetch a IpAddressInstance
*
* @function fetch
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressInstance#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed IpAddressInstance
*/
/* jshint ignore:end */
IpAddressInstance.prototype.fetch = function fetch(callback) {
return this._proxy.fetch(callback);
};
/* jshint ignore:start */
/**
* update a IpAddressInstance
*
* @function update
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressInstance#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.ipAddress] -
* An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
* @param {string} [opts.friendlyName] -
* A human readable descriptive text for this resource, up to 64 characters long.
* @param {number} [opts.cidrPrefixLength] -
* An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed IpAddressInstance
*/
/* jshint ignore:end */
IpAddressInstance.prototype.update = function update(opts, callback) {
return this._proxy.update(opts, callback);
};
/* jshint ignore:start */
/**
* remove a IpAddressInstance
*
* @function remove
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressInstance#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed IpAddressInstance
*/
/* jshint ignore:end */
IpAddressInstance.prototype.remove = function remove(callback) {
return this._proxy.remove(callback);
};
/* jshint ignore:start */
/**
* Provide a user-friendly representation
*
* @function toJSON
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressInstance#
*
* @returns Object
*/
/* jshint ignore:end */
IpAddressInstance.prototype.toJSON = function toJSON() {
let clone = {};
_.forOwn(this, function(value, key) {
if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
clone[key] = value;
}
});
return clone;
};
IpAddressInstance.prototype[util.inspect.custom] = function inspect(depth,
options) {
return util.inspect(this.toJSON(), options);
};
/* jshint ignore:start */
/**
* Initialize the IpAddressContext
*
* @constructor Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressContext
*
* @param {V2010} version - Version of the resource
* @param {sid} accountSid - The unique sid that identifies this account
* @param {sid} ipAccessControlListSid -
* The IpAccessControlList Sid that identifies the IpAddress resources to fetch
* @param {sid} sid - A string that identifies the IpAddress resource to fetch
*/
/* jshint ignore:end */
IpAddressContext = function IpAddressContext(version, accountSid,
ipAccessControlListSid, sid) {
this._version = version;
// Path Solution
this._solution = {accountSid: accountSid, ipAccessControlListSid: ipAccessControlListSid, sid: sid, };
this._uri = `/Accounts/${accountSid}/SIP/IpAccessControlLists/${ipAccessControlListSid}/IpAddresses/${sid}.json`;
};
/* jshint ignore:start */
/**
* fetch a IpAddressInstance
*
* @function fetch
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressContext#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed IpAddressInstance
*/
/* jshint ignore:end */
IpAddressContext.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 IpAddressInstance(
this._version,
payload,
this._solution.accountSid,
this._solution.ipAccessControlListSid,
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 IpAddressInstance
*
* @function update
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressContext#
*
* @param {object} [opts] - Options for request
* @param {string} [opts.ipAddress] -
* An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
* @param {string} [opts.friendlyName] -
* A human readable descriptive text for this resource, up to 64 characters long.
* @param {number} [opts.cidrPrefixLength] -
* An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed IpAddressInstance
*/
/* jshint ignore:end */
IpAddressContext.prototype.update = function update(opts, callback) {
if (_.isFunction(opts)) {
callback = opts;
opts = {};
}
opts = opts || {};
var deferred = Q.defer();
var data = values.of({
'IpAddress': _.get(opts, 'ipAddress'),
'FriendlyName': _.get(opts, 'friendlyName'),
'CidrPrefixLength': _.get(opts, 'cidrPrefixLength')
});
var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
promise = promise.then(function(payload) {
deferred.resolve(new IpAddressInstance(
this._version,
payload,
this._solution.accountSid,
this._solution.ipAccessControlListSid,
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 */
/**
* remove a IpAddressInstance
*
* @function remove
* @memberof Twilio.Api.V2010.AccountContext.SipContext.IpAccessControlListContext.IpAddressContext#
*
* @param {function} [callback] - Callback to handle processed record
*
* @returns {Promise} Resolves to processed IpAddressInstance
*/
/* jshint ignore:end */
IpAddressContext.prototype.remove = function remove(callback) {
var deferred = Q.defer();
var promise = this._version.remove({uri: this._uri, method: 'DELETE'});
promise = promise.then(function(payload) {
deferred.resolve(payload);
}.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.SipContext.IpAccessControlListContext.IpAddressContext#
*
* @returns Object
*/
/* jshint ignore:end */
IpAddressContext.prototype.toJSON = function toJSON() {
return this._solution;
};
IpAddressContext.prototype[util.inspect.custom] = function inspect(depth,
options) {
return util.inspect(this.toJSON(), options);
};
module.exports = {
IpAddressList: IpAddressList,
IpAddressPage: IpAddressPage,
IpAddressInstance: IpAddressInstance,
IpAddressContext: IpAddressContext
};