twilio 4.0.0-rc.5 → 4.0.0

package/README.md

@@ -29,12 +29,6 @@ TypeScript is supported for TypeScript version 2.9 and above.
 
 `npm install twilio` or `yarn add twilio`
 
-### Installing Release Candidates
-
-Or, if you're wanting to install the latest release candidate use:
-
-`npm install twilio@rc` or `yarn add twilio@rc`
-
 ## Sample Usage
 
 Check out these [code examples](examples) in JavaScript and TypeScript to get up and running quickly.
@@ -70,6 +64,22 @@ const client = require('twilio')(accountSid, authToken, {
 });
 ```
 
+### Enable Auto-Retry with Exponential Backoff
+
+`twilio-node` supports automatic retry with exponential backoff when API requests receive an [Error 429 response](https://support.twilio.com/hc/en-us/articles/360044308153-Twilio-API-response-Error-429-Too-Many-Requests-). This retry with exponential backoff feature is disabled by default. To enable this feature, instantiate the Twilio client with the `autoRetry` flag set to `true`.
+
+Optionally, the maximum number of retries performed by this feature can be set with the `maxRetries` flag. The default maximum number of retries is `3`.
+
+```javascript
+var accountSid = process.env.TWILIO_ACCOUNT_SID; // Your Account SID from www.twilio.com/console
+var authToken = process.env.TWILIO_AUTH_TOKEN;   // Your Auth Token from www.twilio.com/console
+
+const client = require('twilio')(accountSid, authToken, {
+    autoRetry: true,
+    maxRetries: 3
+});
+```
+
 ### Specify Region and/or Edge
 
 To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/docs/global-infrastructure), specify the target Region and/or Edge for the client:
@@ -115,7 +125,7 @@ See [example](examples/express.js) for a code sample for incoming Twilio request
 
 ## Handling Exceptions
 
-For an example on how to handle exceptions in this helper library, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/node/usage-guide#exceptions).
+For an example on how to handle exceptions in this helper library, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/node#exceptions).
 
 ## Using a Custom HTTP Client
 

package/dist/lib/base/BaseTwilio.d.ts

@@ -10,6 +10,8 @@ export interface ClientOpts {
     lazyLoading?: boolean;
     logLevel?: string;
     userAgentExtensions?: string[];
+    autoRetry?: boolean;
+    maxRetries?: number;
 }
 export interface RequestOpts {
     method?: HttpMethod;
@@ -35,6 +37,8 @@ export declare class BaseTwilio {
     edge?: string;
     region?: string;
     logLevel?: string;
+    autoRetry: boolean;
+    maxRetries?: number;
     userAgentExtensions?: string[];
     _httpClient?: RequestClient;
     /**

package/dist/lib/base/BaseTwilio.js

@@ -50,6 +50,8 @@ class BaseTwilio {
         this.edge = this.opts.edge || this.env.TWILIO_EDGE;
         this.region = this.opts.region || this.env.TWILIO_REGION;
         this.logLevel = this.opts.logLevel || this.env.TWILIO_LOG_LEVEL;
+        this.autoRetry = this.opts.autoRetry || false;
+        this.maxRetries = this.opts.maxRetries;
         this.userAgentExtensions = this.opts.userAgentExtensions || [];
         this._httpClient = this.opts.httpClient;
         if (this.opts.lazyLoading === false) {
@@ -64,7 +66,10 @@ class BaseTwilio {
     }
     get httpClient() {
         if (!this._httpClient) {
-            this._httpClient = new RequestClient_1.default();
+            this._httpClient = new RequestClient_1.default({
+                autoRetry: this.autoRetry,
+                maxRetries: this.maxRetries,
+            });
         }
         return this._httpClient;
     }

package/dist/lib/base/RequestClient.d.ts

@@ -79,17 +79,34 @@ export interface RequestClientOptions {
     /**
      * https.Agent scheduling option
      */
-    scheduling?: string;
+    scheduling?: "fifo" | "lifo" | undefined;
     /**
      * The private CA certificate bundle (if private SSL certificate)
      */
     ca?: string | Buffer;
+    /**
+     * Enable auto-retry with exponential backoff when receiving 429 Errors from
+     * the API. Disabled by default.
+     */
+    autoRetry?: boolean;
+    /**
+     * Maximum retry delay in milliseconds for 429 Error response retries.
+     * Defaults to 3000.
+     */
+    maxRetryDelay?: number;
+    /**
+     * Maximum number of request retries for 429 Error responses. Defaults to 3.
+     */
+    maxRetries?: number;
 }
 export default class RequestClient {
     defaultTimeout: number;
     axios: AxiosInstance;
     lastResponse?: Response<any>;
     lastRequest?: Request<any>;
+    autoRetry: boolean;
+    maxRetryDelay: number;
+    maxRetries: number;
     /**
      * Make http request
      * @param opts - The options passed to https.Agent
@@ -100,6 +117,9 @@ export default class RequestClient {
      * @param opts.maxTotalSockets - https.Agent maxTotalSockets option
      * @param opts.maxFreeSockets - https.Agent maxFreeSockets option
      * @param opts.scheduling - https.Agent scheduling option
+     * @param opts.autoRetry - Enable auto-retry requests with exponential backoff on 429 responses. Defaults to false.
+     * @param opts.maxRetryDelay - Max retry delay in milliseconds for 429 Too Many Request response retries. Defaults to 3000.
+     * @param opts.maxRetries - Max number of request retries for 429 Too Many Request responses. Defaults to 3.
      */
     constructor(opts?: RequestClientOptions);
     /**

package/dist/lib/base/RequestClient.js

@@ -35,6 +35,29 @@ const response_1 = __importDefault(require("../http/response"));
 const request_1 = __importDefault(require("../http/request"));
 const DEFAULT_CONTENT_TYPE = "application/x-www-form-urlencoded";
 const DEFAULT_TIMEOUT = 30000;
+const DEFAULT_INITIAL_RETRY_INTERVAL_MILLIS = 100;
+const DEFAULT_MAX_RETRY_DELAY = 3000;
+const DEFAULT_MAX_RETRIES = 3;
+function getExpontentialBackoffResponseHandler(axios, opts) {
+    const maxIntervalMillis = opts.maxIntervalMillis;
+    const maxRetries = opts.maxRetries;
+    return function (res) {
+        const config = res.config;
+        if (res.status !== 429) {
+            return res;
+        }
+        const retryCount = (config.retryCount || 0) + 1;
+        if (retryCount <= maxRetries) {
+            config.retryCount = retryCount;
+            const baseDelay = Math.min(maxIntervalMillis, DEFAULT_INITIAL_RETRY_INTERVAL_MILLIS * Math.pow(2, retryCount));
+            const delay = Math.floor(baseDelay * Math.random()); // Full jitter backoff
+            return new Promise((resolve) => {
+                setTimeout(() => resolve(axios(config)), delay);
+            });
+        }
+        return res;
+    };
+}
 class RequestClient {
     /**
      * Make http request
@@ -46,10 +69,16 @@ class RequestClient {
      * @param opts.maxTotalSockets - https.Agent maxTotalSockets option
      * @param opts.maxFreeSockets - https.Agent maxFreeSockets option
      * @param opts.scheduling - https.Agent scheduling option
+     * @param opts.autoRetry - Enable auto-retry requests with exponential backoff on 429 responses. Defaults to false.
+     * @param opts.maxRetryDelay - Max retry delay in milliseconds for 429 Too Many Request response retries. Defaults to 3000.
+     * @param opts.maxRetries - Max number of request retries for 429 Too Many Request responses. Defaults to 3.
      */
     constructor(opts) {
         opts = opts || {};
         this.defaultTimeout = opts.timeout || DEFAULT_TIMEOUT;
+        this.autoRetry = opts.autoRetry || false;
+        this.maxRetryDelay = opts.maxRetryDelay || DEFAULT_MAX_RETRY_DELAY;
+        this.maxRetries = opts.maxRetries || DEFAULT_MAX_RETRIES;
         // construct an https agent
         let agentOpts = {
             timeout: this.defaultTimeout,
@@ -80,6 +109,12 @@ class RequestClient {
         this.axios = axios_1.default.create();
         this.axios.defaults.headers.post["Content-Type"] = DEFAULT_CONTENT_TYPE;
         this.axios.defaults.httpsAgent = agent;
+        if (opts.autoRetry) {
+            this.axios.interceptors.response.use(getExpontentialBackoffResponseHandler(this.axios, {
+                maxIntervalMillis: this.maxRetryDelay,
+                maxRetries: this.maxRetries,
+            }));
+        }
     }
     /**
      * Make http request

package/dist/lib/base/serialize.d.ts

@@ -1,3 +1,4 @@
+import TwiML from "../twiml/TwiML";
 /**
  * @namespace serialize
  */
@@ -39,6 +40,7 @@ export declare function object<T>(o: T): T;
  * @returns a string 'true' or 'false' if passed a boolean, else the value
  */
 export declare function bool(input: string | boolean): string | "true" | "false";
+export declare function twiml(input: TwiML | string): string;
 type MapFunction<TInput, TOutput> = (input: TInput) => TOutput;
 /**
  * Maps transform over each element in input if input is an array

package/dist/lib/base/serialize.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.map = exports.bool = exports.object = exports.prefixedCollapsibleMap = exports.iso8601DateTime = exports.iso8601Date = void 0;
+exports.map = exports.twiml = exports.bool = exports.object = exports.prefixedCollapsibleMap = exports.iso8601DateTime = exports.iso8601Date = void 0;
 const dayjs_1 = __importDefault(require("dayjs"));
 const utc_1 = __importDefault(require("dayjs/plugin/utc"));
 dayjs_1.default.extend(utc_1.default);
@@ -102,6 +102,10 @@ function bool(input) {
     return input;
 }
 exports.bool = bool;
+function twiml(input) {
+    return input.toString();
+}
+exports.twiml = twiml;
 /**
  * Maps transform over each element in input if input is an array
  *

package/dist/lib/rest/Content.d.ts

@@ -1,4 +1,9 @@
 import ContentBase from "./ContentBase";
+import { ContentListInstance } from "./content/v1/content";
 declare class Content extends ContentBase {
+    /**
+     * @deprecated - Use v1.contents instead
+     */
+    get contents(): ContentListInstance;
 }
 export = Content;

package/dist/lib/rest/Content.js

@@ -4,5 +4,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const ContentBase_1 = __importDefault(require("./ContentBase"));
 class Content extends ContentBase_1.default {
+    /**
+     * @deprecated - Use v1.contents instead
+     */
+    get contents() {
+        console.warn("contents is deprecated. Use v1.contents instead.");
+        return this.v1.contents;
+    }
 }
 module.exports = Content;

package/dist/lib/rest/FlexApi.d.ts

@@ -3,8 +3,14 @@ import { ConfigurationListInstance } from "./flexApi/v1/configuration";
 import { FlexFlowListInstance } from "./flexApi/v1/flexFlow";
 import { InteractionListInstance } from "./flexApi/v1/interaction";
 import { WebChannelListInstance } from "./flexApi/v1/webChannel";
+import { AssessmentsListInstance } from "./flexApi/v1/assessments";
+import { WebChannelsListInstance } from "./flexApi/v2/webChannels";
 import FlexApiBase from "./FlexApiBase";
 declare class FlexApi extends FlexApiBase {
+    /**
+     * @deprecated - Use v1.assessments instead
+     */
+    get assessments(): AssessmentsListInstance;
     /**
      * @deprecated - Use v1.channel instead
      */
@@ -25,5 +31,9 @@ declare class FlexApi extends FlexApiBase {
      * @deprecated - Use v1.webChannel instead
      */
     get webChannel(): WebChannelListInstance;
+    /**
+     * @deprecated - Use v2.webChannels instead
+     */
+    get webChannels(): WebChannelsListInstance;
 }
 export = FlexApi;

package/dist/lib/rest/FlexApi.js

@@ -4,6 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const FlexApiBase_1 = __importDefault(require("./FlexApiBase"));
 class FlexApi extends FlexApiBase_1.default {
+    /**
+     * @deprecated - Use v1.assessments instead
+     */
+    get assessments() {
+        console.warn("assessments is deprecated. Use v1.assessments instead.");
+        return this.v1.assessments;
+    }
     /**
      * @deprecated - Use v1.channel instead
      */
@@ -39,5 +46,12 @@ class FlexApi extends FlexApiBase_1.default {
         console.warn("webChannel is deprecated. Use v1.webChannel instead.");
         return this.v1.webChannel;
     }
+    /**
+     * @deprecated - Use v2.webChannels instead
+     */
+    get webChannels() {
+        console.warn("webChannels is deprecated. Use v2.webChannels instead.");
+        return this.v2.webChannels;
+    }
 }
 module.exports = FlexApi;

package/dist/lib/rest/Messaging.d.ts

@@ -3,6 +3,8 @@ import { DeactivationsListInstance } from "./messaging/v1/deactivations";
 import { ExternalCampaignListInstance } from "./messaging/v1/externalCampaign";
 import { ServiceListInstance } from "./messaging/v1/service";
 import { UsecaseListInstance } from "./messaging/v1/usecase";
+import { DomainCertsListInstance } from "./messaging/v1/domainCerts";
+import { DomainConfigListInstance } from "./messaging/v1/domainConfig";
 import MessagingBase from "./MessagingBase";
 declare class Messaging extends MessagingBase {
     /**
@@ -13,6 +15,14 @@ declare class Messaging extends MessagingBase {
      * @deprecated - Use v1.deactivations instead
      */
     get deactivations(): DeactivationsListInstance;
+    /**
+     * @deprecated - Use v1.domainCerts instead
+     */
+    get domainCerts(): DomainCertsListInstance;
+    /**
+     * @deprecated - Use v1.domainConfig instead
+     */
+    get domainConfig(): DomainConfigListInstance;
     /**
      * @deprecated - Use v1.externalCampaign instead
      */

package/dist/lib/rest/Messaging.js

@@ -18,6 +18,20 @@ class Messaging extends MessagingBase_1.default {
         console.warn("deactivations is deprecated. Use v1.deactivations instead.");
         return this.v1.deactivations;
     }
+    /**
+     * @deprecated - Use v1.domainCerts instead
+     */
+    get domainCerts() {
+        console.warn("domainCerts is deprecated. Use v1.domainCerts instead.");
+        return this.v1.domainCerts;
+    }
+    /**
+     * @deprecated - Use v1.domainConfig instead
+     */
+    get domainConfig() {
+        console.warn("domainConfig is deprecated. Use v1.domainConfig instead.");
+        return this.v1.domainConfig;
+    }
     /**
      * @deprecated - Use v1.externalCampaign instead
      */

package/dist/lib/rest/Oauth.d.ts

@@ -1,9 +1,14 @@
 import OauthBase from "./OauthBase";
 import { OauthListInstance } from "./oauth/v1/oauth";
+import { DeviceCodeListInstance } from "./oauth/v1/deviceCode";
 import { OpenidDiscoveryListInstance } from "./oauth/v1/openidDiscovery";
 import { TokenListInstance } from "./oauth/v1/token";
 import { UserInfoListInstance } from "./oauth/v1/userInfo";
 declare class Oauth extends OauthBase {
+    /**
+     * @deprecated - Use v1.deviceCode instead
+     */
+    get deviceCode(): DeviceCodeListInstance;
     /**
      * @deprecated - Use v1.oauth instead
      */

package/dist/lib/rest/Oauth.js

@@ -4,6 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const OauthBase_1 = __importDefault(require("./OauthBase"));
 class Oauth extends OauthBase_1.default {
+    /**
+     * @deprecated - Use v1.deviceCode instead
+     */
+    get deviceCode() {
+        console.warn("deviceCode is deprecated. Use v1.deviceCode instead.");
+        return this.v1.deviceCode;
+    }
     /**
      * @deprecated - Use v1.oauth instead
      */

package/dist/lib/rest/Supersim.d.ts

@@ -3,6 +3,7 @@ import { FleetListInstance } from "./supersim/v1/fleet";
 import { IpCommandListInstance } from "./supersim/v1/ipCommand";
 import { NetworkListInstance } from "./supersim/v1/network";
 import { NetworkAccessProfileListInstance } from "./supersim/v1/networkAccessProfile";
+import { SettingsUpdateListInstance } from "./supersim/v1/settingsUpdate";
 import { SimListInstance } from "./supersim/v1/sim";
 import { SmsCommandListInstance } from "./supersim/v1/smsCommand";
 import { UsageRecordListInstance } from "./supersim/v1/usageRecord";
@@ -24,6 +25,10 @@ declare class Supersim extends SupersimBase {
      * @deprecated - Use v1.networks instead
      */
     get networks(): NetworkListInstance;
+    /**
+     * @deprecated - Use v1.settingsUpdates instead
+     */
+    get settingsUpdates(): SettingsUpdateListInstance;
     /**
      * @deprecated - Use v1.networkAccessProfiles instead
      */

package/dist/lib/rest/Supersim.js

@@ -32,6 +32,13 @@ class Supersim extends SupersimBase_1.default {
         console.warn("networks is deprecated. Use v1.networks instead.");
         return this.v1.networks;
     }
+    /**
+     * @deprecated - Use v1.settingsUpdates instead
+     */
+    get settingsUpdates() {
+        console.warn("settingsUpdates is deprecated. Use v1.settingsUpdates instead.");
+        return this.v1.settingsUpdates;
+    }
     /**
      * @deprecated - Use v1.networkAccessProfiles instead
      */

package/dist/lib/rest/accounts/v1/authTokenPromotion.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { inspect, InspectOptions } from "util";
 import V1 from "../V1";
 export interface AuthTokenPromotionContext {
@@ -46,19 +45,19 @@ export declare class AuthTokenPromotionInstance {
     protected _context?: AuthTokenPromotionContext;
     constructor(_version: V1, payload: AuthTokenPromotionResource);
     /**
-     * The SID of the Account that the secondary Auth Token was created for
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the secondary Auth Token was created for.
      */
     accountSid: string;
     /**
-     * The promoted Auth Token
+     * The promoted Auth Token that must be used to authenticate future API requests.
      */
     authToken: string;
     /**
-     * The ISO 8601 formatted date and time in UTC when the resource was created
+     * The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
      */
     dateCreated: Date;
     /**
-     * The ISO 8601 formatted date and time in UTC when the resource was last updated
+     * The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
      */
     dateUpdated: Date;
     /**

package/dist/lib/rest/accounts/v1/credential/aws.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../../base/Page";
 import Response from "../../../../http/response";
@@ -131,23 +130,23 @@ export declare class AwsInstance {
     protected _context?: AwsContext;
     constructor(_version: V1, payload: AwsResource, sid?: string);
     /**
-     * The unique string that identifies the resource
+     * The unique string that we created to identify the AWS resource.
      */
     sid: string;
     /**
-     * The SID of the Account that created the resource
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AWS resource.
      */
     accountSid: string;
     /**
-     * The string that you assigned to describe the resource
+     * The string that you assigned to describe the resource.
      */
     friendlyName: string;
     /**
-     * The RFC 2822 date and time in GMT when the resource was created
+     * The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
      */
     dateCreated: Date;
     /**
-     * The RFC 2822 date and time in GMT when the resource was last updated
+     * The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
      */
     dateUpdated: Date;
     /**

package/dist/lib/rest/accounts/v1/credential/publicKey.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../../base/Page";
 import Response from "../../../../http/response";
@@ -131,23 +130,23 @@ export declare class PublicKeyInstance {
     protected _context?: PublicKeyContext;
     constructor(_version: V1, payload: PublicKeyResource, sid?: string);
     /**
-     * The unique string that identifies the resource
+     * The unique string that that we created to identify the PublicKey resource.
      */
     sid: string;
     /**
-     * The SID of the Account that created the Credential that the PublicKey resource belongs to
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Credential that the PublicKey resource belongs to.
      */
     accountSid: string;
     /**
-     * The string that you assigned to describe the resource
+     * The string that you assigned to describe the resource.
      */
     friendlyName: string;
     /**
-     * The RFC 2822 date and time in GMT when the resource was created
+     * The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
      */
     dateCreated: Date;
     /**
-     * The RFC 2822 date and time in GMT when the resource was last updated
+     * The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
      */
     dateUpdated: Date;
     /**

package/dist/lib/rest/accounts/v1/credential.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { inspect, InspectOptions } from "util";
 import V1 from "../V1";
 import { AwsListInstance } from "./credential/aws";

package/dist/lib/rest/accounts/v1/secondaryAuthToken.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { inspect, InspectOptions } from "util";
 import V1 from "../V1";
 export interface SecondaryAuthTokenContext {
@@ -55,19 +54,19 @@ export declare class SecondaryAuthTokenInstance {
     protected _context?: SecondaryAuthTokenContext;
     constructor(_version: V1, payload: SecondaryAuthTokenResource);
     /**
-     * The SID of the Account that the secondary Auth Token was created for
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the secondary Auth Token was created for.
      */
     accountSid: string;
     /**
-     * The ISO 8601 formatted date and time in UTC when the resource was created
+     * The date and time in UTC when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
      */
     dateCreated: Date;
     /**
-     * The ISO 8601 formatted date and time in UTC when the resource was last updated
+     * The date and time in UTC when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
      */
     dateUpdated: Date;
     /**
-     * The generated secondary Auth Token
+     * The generated secondary Auth Token that can be used to authenticate future API requests.
      */
     secondaryAuthToken: string;
     /**