twilio 3.80.0 → 3.82.0

package/lib/rest/routes/v2/sipDomain.d.ts

@@ -0,0 +1,168 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../base/Page');
+import Response = require('../../../http/response');
+import V2 = require('../V2');
+import { SerializableClass } from '../../../interfaces';
+
+/**
+ * Initialize the SipDomainList
+ *
+ * @param version - Version of the resource
+ */
+declare function SipDomainList(version: V2): SipDomainListInstance;
+
+/**
+ * Options to pass to update
+ *
+ * @property friendlyName - The friendly_name
+ * @property voiceRegion - The voice_region
+ */
+interface SipDomainInstanceUpdateOptions {
+  friendlyName?: string;
+  voiceRegion?: string;
+}
+
+interface SipDomainListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): SipDomainContext;
+  /**
+   * Constructs a sip_domain
+   *
+   * @param sipDomain - The sip_domain
+   */
+  get(sipDomain: string): SipDomainContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+interface SipDomainPayload extends SipDomainResource, Page.TwilioResponsePayload {
+}
+
+interface SipDomainResource {
+  account_sid: string;
+  date_created: Date;
+  date_updated: Date;
+  friendly_name: string;
+  sid: string;
+  sip_domain: string;
+  url: string;
+  voice_region: string;
+}
+
+interface SipDomainSolution {
+}
+
+
+declare class SipDomainContext {
+  /**
+   * Initialize the SipDomainContext
+   *
+   * @param version - Version of the resource
+   * @param sipDomain - The sip_domain
+   */
+  constructor(version: V2, sipDomain: string);
+
+  /**
+   * fetch a SipDomainInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: SipDomainInstance) => any): Promise<SipDomainInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  /**
+   * update a SipDomainInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: SipDomainInstance) => any): Promise<SipDomainInstance>;
+  /**
+   * update a SipDomainInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: SipDomainInstanceUpdateOptions, callback?: (error: Error | null, items: SipDomainInstance) => any): Promise<SipDomainInstance>;
+}
+
+
+declare class SipDomainInstance extends SerializableClass {
+  /**
+   * Initialize the SipDomainContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param sipDomain - The sip_domain
+   */
+  constructor(version: V2, payload: SipDomainPayload, sipDomain: string);
+
+  private _proxy: SipDomainContext;
+  accountSid: string;
+  dateCreated: Date;
+  dateUpdated: Date;
+  /**
+   * fetch a SipDomainInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: SipDomainInstance) => any): Promise<SipDomainInstance>;
+  friendlyName: string;
+  sid: string;
+  sipDomain: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  /**
+   * update a SipDomainInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: SipDomainInstance) => any): Promise<SipDomainInstance>;
+  /**
+   * update a SipDomainInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: SipDomainInstanceUpdateOptions, callback?: (error: Error | null, items: SipDomainInstance) => any): Promise<SipDomainInstance>;
+  url: string;
+  voiceRegion: string;
+}
+
+
+declare class SipDomainPage extends Page<V2, SipDomainPayload, SipDomainResource, SipDomainInstance> {
+  /**
+   * Initialize the SipDomainPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V2, response: Response<string>, solution: SipDomainSolution);
+
+  /**
+   * Build an instance of SipDomainInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: SipDomainPayload): SipDomainInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { SipDomainContext, SipDomainInstance, SipDomainInstanceUpdateOptions, SipDomainList, SipDomainListInstance, SipDomainPage, SipDomainPayload, SipDomainResource, SipDomainSolution }

package/lib/rest/routes/v2/sipDomain.js

@@ -0,0 +1,383 @@
+'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 SipDomainList;
+var SipDomainPage;
+var SipDomainInstance;
+var SipDomainContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the SipDomainList
+ *
+ * @constructor Twilio.Routes.V2.SipDomainList
+ *
+ * @param {Twilio.Routes.V2} version - Version of the resource
+ */
+/* jshint ignore:end */
+SipDomainList = function SipDomainList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function sipDomains
+   * @memberof Twilio.Routes.V2#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Routes.V2.SipDomainContext}
+   */
+  /* jshint ignore:end */
+  function SipDomainListInstance(sid) {
+    return SipDomainListInstance.get(sid);
+  }
+
+  SipDomainListInstance._version = version;
+  // Path Solution
+  SipDomainListInstance._solution = {};
+  /* jshint ignore:start */
+  /**
+   * Constructs a sip_domain
+   *
+   * @function get
+   * @memberof Twilio.Routes.V2.SipDomainList#
+   *
+   * @param {string} sipDomain - The sip_domain
+   *
+   * @returns {Twilio.Routes.V2.SipDomainContext}
+   */
+  /* jshint ignore:end */
+  SipDomainListInstance.get = function get(sipDomain) {
+    return new SipDomainContext(this._version, sipDomain);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Routes.V2.SipDomainList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  SipDomainListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  SipDomainListInstance[util.inspect.custom] = function inspect(depth, options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return SipDomainListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the SipDomainPage
+ *
+ * @constructor Twilio.Routes.V2.SipDomainPage
+ *
+ * @param {V2} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {SipDomainSolution} solution - Path solution
+ *
+ * @returns SipDomainPage
+ */
+/* jshint ignore:end */
+SipDomainPage = function SipDomainPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(SipDomainPage.prototype, Page.prototype);
+SipDomainPage.prototype.constructor = SipDomainPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of SipDomainInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Routes.V2.SipDomainPage#
+ *
+ * @param {SipDomainPayload} payload - Payload response from the API
+ *
+ * @returns SipDomainInstance
+ */
+/* jshint ignore:end */
+SipDomainPage.prototype.getInstance = function getInstance(payload) {
+  return new SipDomainInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Routes.V2.SipDomainPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+SipDomainPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+SipDomainPage.prototype[util.inspect.custom] = function inspect(depth, options)
+    {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the SipDomainContext
+ *
+ * @constructor Twilio.Routes.V2.SipDomainInstance
+ *
+ * @property {string} sipDomain - The sip_domain
+ * @property {string} url - The url
+ * @property {string} sid - The sid
+ * @property {string} accountSid - The account_sid
+ * @property {string} friendlyName - The friendly_name
+ * @property {string} voiceRegion - The voice_region
+ * @property {Date} dateCreated - The date_created
+ * @property {Date} dateUpdated - The date_updated
+ *
+ * @param {V2} version - Version of the resource
+ * @param {SipDomainPayload} payload - The instance payload
+ * @param {string} sipDomain - The sip_domain
+ */
+/* jshint ignore:end */
+SipDomainInstance = function SipDomainInstance(version, payload, sipDomain) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.sipDomain = payload.sip_domain; // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+  this.sid = payload.sid; // jshint ignore:line
+  this.accountSid = payload.account_sid; // jshint ignore:line
+  this.friendlyName = payload.friendly_name; // jshint ignore:line
+  this.voiceRegion = payload.voice_region; // jshint ignore:line
+  this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
+  this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {sipDomain: sipDomain || this.sipDomain, };
+};
+
+Object.defineProperty(SipDomainInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new SipDomainContext(this._version, this._solution.sipDomain);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * update a SipDomainInstance
+ *
+ * @function update
+ * @memberof Twilio.Routes.V2.SipDomainInstance#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.voiceRegion] - The voice_region
+ * @param {string} [opts.friendlyName] - The friendly_name
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed SipDomainInstance
+ */
+/* jshint ignore:end */
+SipDomainInstance.prototype.update = function update(opts, callback) {
+  return this._proxy.update(opts, callback);
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a SipDomainInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Routes.V2.SipDomainInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed SipDomainInstance
+ */
+/* jshint ignore:end */
+SipDomainInstance.prototype.fetch = function fetch(callback) {
+  return this._proxy.fetch(callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Routes.V2.SipDomainInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+SipDomainInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+SipDomainInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the SipDomainContext
+ *
+ * @constructor Twilio.Routes.V2.SipDomainContext
+ *
+ * @param {V2} version - Version of the resource
+ * @param {string} sipDomain - The sip_domain
+ */
+/* jshint ignore:end */
+SipDomainContext = function SipDomainContext(version, sipDomain) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {sipDomain: sipDomain, };
+  this._uri = `/SipDomains/${sipDomain}`;
+};
+
+/* jshint ignore:start */
+/**
+ * update a SipDomainInstance
+ *
+ * @function update
+ * @memberof Twilio.Routes.V2.SipDomainContext#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.voiceRegion] - The voice_region
+ * @param {string} [opts.friendlyName] - The friendly_name
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed SipDomainInstance
+ */
+/* jshint ignore:end */
+SipDomainContext.prototype.update = function update(opts, callback) {
+  if (_.isFunction(opts)) {
+    callback = opts;
+    opts = {};
+  }
+  opts = opts || {};
+
+  var deferred = Q.defer();
+  var data = values.of({
+    'VoiceRegion': _.get(opts, 'voiceRegion'),
+    'FriendlyName': _.get(opts, 'friendlyName')
+  });
+
+  var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new SipDomainInstance(this._version, payload, this._solution.sipDomain));
+  }.bind(this));
+
+  promise.catch(function(error) {
+    deferred.reject(error);
+  });
+
+  if (_.isFunction(callback)) {
+    deferred.promise.nodeify(callback);
+  }
+
+  return deferred.promise;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a SipDomainInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Routes.V2.SipDomainContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed SipDomainInstance
+ */
+/* jshint ignore:end */
+SipDomainContext.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 SipDomainInstance(this._version, payload, this._solution.sipDomain));
+  }.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.Routes.V2.SipDomainContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+SipDomainContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+SipDomainContext.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  SipDomainList: SipDomainList,
+  SipDomainPage: SipDomainPage,
+  SipDomainInstance: SipDomainInstance,
+  SipDomainContext: SipDomainContext
+};

package/lib/rest/routes/v2/trunk.d.ts

@@ -0,0 +1,168 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../base/Page');
+import Response = require('../../../http/response');
+import V2 = require('../V2');
+import { SerializableClass } from '../../../interfaces';
+
+/**
+ * Initialize the TrunkList
+ *
+ * @param version - Version of the resource
+ */
+declare function TrunkList(version: V2): TrunkListInstance;
+
+/**
+ * Options to pass to update
+ *
+ * @property friendlyName - A human readable description of this resource.
+ * @property voiceRegion - The Inbound Processing Region used for this SIP Trunk for voice
+ */
+interface TrunkInstanceUpdateOptions {
+  friendlyName?: string;
+  voiceRegion?: string;
+}
+
+interface TrunkListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): TrunkContext;
+  /**
+   * Constructs a trunk
+   *
+   * @param sipTrunkDomain - The SIP Trunk
+   */
+  get(sipTrunkDomain: string): TrunkContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+interface TrunkPayload extends TrunkResource, Page.TwilioResponsePayload {
+}
+
+interface TrunkResource {
+  account_sid: string;
+  date_created: Date;
+  date_updated: Date;
+  friendly_name: string;
+  sid: string;
+  sip_trunk_domain: string;
+  url: string;
+  voice_region: string;
+}
+
+interface TrunkSolution {
+}
+
+
+declare class TrunkContext {
+  /**
+   * Initialize the TrunkContext
+   *
+   * @param version - Version of the resource
+   * @param sipTrunkDomain - The SIP Trunk
+   */
+  constructor(version: V2, sipTrunkDomain: string);
+
+  /**
+   * fetch a TrunkInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: TrunkInstance) => any): Promise<TrunkInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  /**
+   * update a TrunkInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: TrunkInstance) => any): Promise<TrunkInstance>;
+  /**
+   * update a TrunkInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: TrunkInstanceUpdateOptions, callback?: (error: Error | null, items: TrunkInstance) => any): Promise<TrunkInstance>;
+}
+
+
+declare class TrunkInstance extends SerializableClass {
+  /**
+   * Initialize the TrunkContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param sipTrunkDomain - The SIP Trunk
+   */
+  constructor(version: V2, payload: TrunkPayload, sipTrunkDomain: string);
+
+  private _proxy: TrunkContext;
+  accountSid: string;
+  dateCreated: Date;
+  dateUpdated: Date;
+  /**
+   * fetch a TrunkInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: TrunkInstance) => any): Promise<TrunkInstance>;
+  friendlyName: string;
+  sid: string;
+  sipTrunkDomain: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  /**
+   * update a TrunkInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: TrunkInstance) => any): Promise<TrunkInstance>;
+  /**
+   * update a TrunkInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: TrunkInstanceUpdateOptions, callback?: (error: Error | null, items: TrunkInstance) => any): Promise<TrunkInstance>;
+  url: string;
+  voiceRegion: string;
+}
+
+
+declare class TrunkPage extends Page<V2, TrunkPayload, TrunkResource, TrunkInstance> {
+  /**
+   * Initialize the TrunkPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V2, response: Response<string>, solution: TrunkSolution);
+
+  /**
+   * Build an instance of TrunkInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: TrunkPayload): TrunkInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { TrunkContext, TrunkInstance, TrunkInstanceUpdateOptions, TrunkList, TrunkListInstance, TrunkPage, TrunkPayload, TrunkResource, TrunkSolution }