twilio 3.83.0 → 3.83.1

package/lib/rest/api/v2010/account/call/userDefinedMessage.d.ts

@@ -0,0 +1,107 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../../../base/Page');
+import Response = require('../../../../../http/response');
+import V2010 = require('../../../V2010');
+import { SerializableClass } from '../../../../../interfaces';
+
+/**
+ * Initialize the UserDefinedMessageList
+ *
+ * @param version - Version of the resource
+ * @param accountSid - Account Sid.
+ * @param callSid - Call Sid.
+ */
+declare function UserDefinedMessageList(version: V2010, accountSid: string, callSid: string): UserDefinedMessageListInstance;
+
+interface UserDefinedMessageListInstance {
+  /**
+   * create a UserDefinedMessageInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  create(opts: UserDefinedMessageListInstanceCreateOptions, callback?: (error: Error | null, item: UserDefinedMessageInstance) => any): Promise<UserDefinedMessageInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+/**
+ * Options to pass to create
+ *
+ * @property content - A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
+ * @property idempotencyKey - A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
+ */
+interface UserDefinedMessageListInstanceCreateOptions {
+  content: string;
+  idempotencyKey?: string;
+}
+
+interface UserDefinedMessagePayload extends UserDefinedMessageResource, Page.TwilioResponsePayload {
+}
+
+interface UserDefinedMessageResource {
+  account_sid: string;
+  call_sid: string;
+  date_created: Date;
+  sid: string;
+}
+
+interface UserDefinedMessageSolution {
+  accountSid?: string;
+  callSid?: string;
+}
+
+
+declare class UserDefinedMessageInstance extends SerializableClass {
+  /**
+   * Initialize the UserDefinedMessageContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param accountSid - Account Sid.
+   * @param callSid - Call Sid.
+   */
+  constructor(version: V2010, payload: UserDefinedMessagePayload, accountSid: string, callSid: string);
+
+  accountSid: string;
+  callSid: string;
+  dateCreated: Date;
+  sid: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class UserDefinedMessagePage extends Page<V2010, UserDefinedMessagePayload, UserDefinedMessageResource, UserDefinedMessageInstance> {
+  /**
+   * Initialize the UserDefinedMessagePage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V2010, response: Response<string>, solution: UserDefinedMessageSolution);
+
+  /**
+   * Build an instance of UserDefinedMessageInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: UserDefinedMessagePayload): UserDefinedMessageInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { UserDefinedMessageInstance, UserDefinedMessageList, UserDefinedMessageListInstance, UserDefinedMessageListInstanceCreateOptions, UserDefinedMessagePage, UserDefinedMessagePayload, UserDefinedMessageResource, UserDefinedMessageSolution }

package/lib/rest/api/v2010/account/call/userDefinedMessage.js

@@ -0,0 +1,259 @@
+'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 UserDefinedMessageList;
+var UserDefinedMessagePage;
+var UserDefinedMessageInstance;
+
+/* jshint ignore:start */
+/**
+ * Initialize the UserDefinedMessageList
+ *
+ * @constructor Twilio.Api.V2010.AccountContext.CallContext.UserDefinedMessageList
+ *
+ * @param {Twilio.Api.V2010} version - Version of the resource
+ * @param {string} accountSid - Account Sid.
+ * @param {string} callSid - Call Sid.
+ */
+/* jshint ignore:end */
+UserDefinedMessageList = function UserDefinedMessageList(version, accountSid,
+                                                          callSid) {
+  /* jshint ignore:start */
+  /**
+   * @function userDefinedMessages
+   * @memberof Twilio.Api.V2010.AccountContext.CallContext#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Api.V2010.AccountContext.CallContext.UserDefinedMessageContext}
+   */
+  /* jshint ignore:end */
+  function UserDefinedMessageListInstance(sid) {
+    return UserDefinedMessageListInstance.get(sid);
+  }
+
+  UserDefinedMessageListInstance._version = version;
+  // Path Solution
+  UserDefinedMessageListInstance._solution = {accountSid: accountSid, callSid: callSid};
+  UserDefinedMessageListInstance._uri = `/Accounts/${accountSid}/Calls/${callSid}/UserDefinedMessages.json`;
+  /* jshint ignore:start */
+  /**
+   * create a UserDefinedMessageInstance
+   *
+   * @function create
+   * @memberof Twilio.Api.V2010.AccountContext.CallContext.UserDefinedMessageList#
+   *
+   * @param {object} opts - Options for request
+   * @param {string} opts.content -
+   *          A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
+   * @param {string} [opts.idempotencyKey] -
+   *          A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
+   * @param {function} [callback] - Callback to handle processed record
+   *
+   * @returns {Promise} Resolves to processed UserDefinedMessageInstance
+   */
+  /* jshint ignore:end */
+  UserDefinedMessageListInstance.create = function create(opts, callback) {
+    if (_.isUndefined(opts)) {
+      throw new Error('Required parameter "opts" missing.');
+    }
+    if (_.isUndefined(opts['content'])) {
+      throw new Error('Required parameter "opts[\'content\']" missing.');
+    }
+
+    var deferred = Q.defer();
+    var data = values.of({
+      'Content': _.get(opts, 'content'),
+      'IdempotencyKey': _.get(opts, 'idempotencyKey')
+    });
+
+    var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
+
+    promise = promise.then(function(payload) {
+      deferred.resolve(new UserDefinedMessageInstance(this._version, 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.CallContext.UserDefinedMessageList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  UserDefinedMessageListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  UserDefinedMessageListInstance[util.inspect.custom] = function inspect(depth,
+      options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return UserDefinedMessageListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the UserDefinedMessagePage
+ *
+ * @constructor Twilio.Api.V2010.AccountContext.CallContext.UserDefinedMessagePage
+ *
+ * @param {V2010} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {UserDefinedMessageSolution} solution - Path solution
+ *
+ * @returns UserDefinedMessagePage
+ */
+/* jshint ignore:end */
+UserDefinedMessagePage = function UserDefinedMessagePage(version, response,
+                                                          solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(UserDefinedMessagePage.prototype, Page.prototype);
+UserDefinedMessagePage.prototype.constructor = UserDefinedMessagePage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of UserDefinedMessageInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Api.V2010.AccountContext.CallContext.UserDefinedMessagePage#
+ *
+ * @param {UserDefinedMessagePayload} payload - Payload response from the API
+ *
+ * @returns UserDefinedMessageInstance
+ */
+/* jshint ignore:end */
+UserDefinedMessagePage.prototype.getInstance = function getInstance(payload) {
+  return new UserDefinedMessageInstance(
+    this._version,
+    payload,
+    this._solution.accountSid,
+    this._solution.callSid
+  );
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Api.V2010.AccountContext.CallContext.UserDefinedMessagePage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+UserDefinedMessagePage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+UserDefinedMessagePage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the UserDefinedMessageContext
+ *
+ * @constructor Twilio.Api.V2010.AccountContext.CallContext.UserDefinedMessageInstance
+ *
+ * @property {string} accountSid - Account Sid.
+ * @property {string} callSid - Call Sid.
+ * @property {string} sid -
+ *          A string that uniquely identifies this User Defined Message.
+ * @property {Date} dateCreated - The date this User Defined Message was created
+ *
+ * @param {V2010} version - Version of the resource
+ * @param {UserDefinedMessagePayload} payload - The instance payload
+ * @param {sid} accountSid - Account Sid.
+ * @param {sid} callSid - Call Sid.
+ */
+/* jshint ignore:end */
+UserDefinedMessageInstance = function UserDefinedMessageInstance(version,
+    payload, accountSid, callSid) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.accountSid = payload.account_sid; // jshint ignore:line
+  this.callSid = payload.call_sid; // jshint ignore:line
+  this.sid = payload.sid; // jshint ignore:line
+  this.dateCreated = deserialize.rfc2822DateTime(payload.date_created); // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {accountSid: accountSid, callSid: callSid, };
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Api.V2010.AccountContext.CallContext.UserDefinedMessageInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+UserDefinedMessageInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+UserDefinedMessageInstance.prototype[util.inspect.custom] = function
+    inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  UserDefinedMessageList: UserDefinedMessageList,
+  UserDefinedMessagePage: UserDefinedMessagePage,
+  UserDefinedMessageInstance: UserDefinedMessageInstance
+};

package/lib/rest/api/v2010/account/call/userDefinedMessageSubscription.d.ts

@@ -0,0 +1,153 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../../../base/Page');
+import Response = require('../../../../../http/response');
+import V2010 = require('../../../V2010');
+import { SerializableClass } from '../../../../../interfaces';
+
+/**
+ * Initialize the UserDefinedMessageSubscriptionList
+ *
+ * @param version - Version of the resource
+ * @param accountSid - Account Sid.
+ * @param callSid - Call Sid.
+ */
+declare function UserDefinedMessageSubscriptionList(version: V2010, accountSid: string, callSid: string): UserDefinedMessageSubscriptionListInstance;
+
+interface UserDefinedMessageSubscriptionListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): UserDefinedMessageSubscriptionContext;
+  /**
+   * create a UserDefinedMessageSubscriptionInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  create(opts: UserDefinedMessageSubscriptionListInstanceCreateOptions, callback?: (error: Error | null, item: UserDefinedMessageSubscriptionInstance) => any): Promise<UserDefinedMessageSubscriptionInstance>;
+  /**
+   * Constructs a user_defined_message_subscription
+   *
+   * @param sid - User Defined Message Subscription Sid
+   */
+  get(sid: string): UserDefinedMessageSubscriptionContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+/**
+ * Options to pass to create
+ *
+ * @property callback - The URL we should call to send user defined messages.
+ * @property idempotencyKey - A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
+ * @property method - HTTP method used with the callback.
+ */
+interface UserDefinedMessageSubscriptionListInstanceCreateOptions {
+  callback: string;
+  idempotencyKey?: string;
+  method: string;
+}
+
+interface UserDefinedMessageSubscriptionPayload extends UserDefinedMessageSubscriptionResource, Page.TwilioResponsePayload {
+}
+
+interface UserDefinedMessageSubscriptionResource {
+  account_sid: string;
+  call_sid: string;
+  date_created: Date;
+  sid: string;
+  uri: string;
+}
+
+interface UserDefinedMessageSubscriptionSolution {
+  accountSid?: string;
+  callSid?: string;
+}
+
+
+declare class UserDefinedMessageSubscriptionContext {
+  /**
+   * Initialize the UserDefinedMessageSubscriptionContext
+   *
+   * @param version - Version of the resource
+   * @param accountSid - Account Sid.
+   * @param callSid - Call Sid.
+   * @param sid - User Defined Message Subscription Sid
+   */
+  constructor(version: V2010, accountSid: string, callSid: string, sid: string);
+
+  /**
+   * remove a UserDefinedMessageSubscriptionInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  remove(callback?: (error: Error | null, items: UserDefinedMessageSubscriptionInstance) => any): Promise<boolean>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class UserDefinedMessageSubscriptionInstance extends SerializableClass {
+  /**
+   * Initialize the UserDefinedMessageSubscriptionContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param accountSid - Account Sid.
+   * @param callSid - Call Sid.
+   * @param sid - User Defined Message Subscription Sid
+   */
+  constructor(version: V2010, payload: UserDefinedMessageSubscriptionPayload, accountSid: string, callSid: string, sid: string);
+
+  private _proxy: UserDefinedMessageSubscriptionContext;
+  accountSid: string;
+  callSid: string;
+  dateCreated: Date;
+  /**
+   * remove a UserDefinedMessageSubscriptionInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  remove(callback?: (error: Error | null, items: UserDefinedMessageSubscriptionInstance) => any): Promise<boolean>;
+  sid: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  uri: string;
+}
+
+
+declare class UserDefinedMessageSubscriptionPage extends Page<V2010, UserDefinedMessageSubscriptionPayload, UserDefinedMessageSubscriptionResource, UserDefinedMessageSubscriptionInstance> {
+  /**
+   * Initialize the UserDefinedMessageSubscriptionPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V2010, response: Response<string>, solution: UserDefinedMessageSubscriptionSolution);
+
+  /**
+   * Build an instance of UserDefinedMessageSubscriptionInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: UserDefinedMessageSubscriptionPayload): UserDefinedMessageSubscriptionInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { UserDefinedMessageSubscriptionContext, UserDefinedMessageSubscriptionInstance, UserDefinedMessageSubscriptionList, UserDefinedMessageSubscriptionListInstance, UserDefinedMessageSubscriptionListInstanceCreateOptions, UserDefinedMessageSubscriptionPage, UserDefinedMessageSubscriptionPayload, UserDefinedMessageSubscriptionResource, UserDefinedMessageSubscriptionSolution }