twilio 5.0.3 → 5.1.0

package/README.md

@@ -22,6 +22,7 @@ This library supports the following Node.js implementations:
 - Node.js 14
 - Node.js 16
 - Node.js 18
+- Node.js LTS (20) 
 
 TypeScript is supported for TypeScript version 2.9 and above.
 

package/lib/rest/ContentBase.d.ts

@@ -1,7 +1,9 @@
 import Domain from "../base/Domain";
 import V1 from "./content/V1";
+import V2 from "./content/V2";
 declare class ContentBase extends Domain {
     _v1?: V1;
+    _v2?: V2;
     /**
      * Initialize content domain
      *
@@ -9,5 +11,6 @@ declare class ContentBase extends Domain {
      */
     constructor(twilio: any);
     get v1(): V1;
+    get v2(): V2;
 }
 export = ContentBase;

package/lib/rest/ContentBase.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const Domain_1 = __importDefault(require("../base/Domain"));
 const V1_1 = __importDefault(require("./content/V1"));
+const V2_1 = __importDefault(require("./content/V2"));
 class ContentBase extends Domain_1.default {
     /**
      * Initialize content domain
@@ -27,5 +28,9 @@ class ContentBase extends Domain_1.default {
         this._v1 = this._v1 || new V1_1.default(this);
         return this._v1;
     }
+    get v2() {
+        this._v2 = this._v2 || new V2_1.default(this);
+        return this._v2;
+    }
 }
 module.exports = ContentBase;

package/lib/rest/Twilio.d.ts

@@ -12,7 +12,6 @@ import Insights from "./Insights";
 import Intelligence from "./Intelligence";
 import IpMessaging from "./IpMessaging";
 import Lookups from "./Lookups";
-import PreviewMessaging from "./PreviewMessaging";
 import Messaging from "./Messaging";
 import Microvisor from "./Microvisor";
 import Monitor from "./Monitor";
@@ -88,8 +87,6 @@ declare class Twilio extends Client {
     _ipMessaging?: IpMessaging;
     /** (Twilio.Lookups) - lookups domain */
     _lookups?: Lookups;
-    /** (Twilio.PreviewMessaging) - previewMessaging domain */
-    _previewMessaging?: PreviewMessaging;
     /** (Twilio.Messaging) - messaging domain */
     _messaging?: Messaging;
     /** (Twilio.Microvisor) - microvisor domain */
@@ -170,8 +167,6 @@ declare class Twilio extends Client {
     get ipMessaging(): IpMessaging;
     /** Getter for (Twilio.Lookups) domain */
     get lookups(): Lookups;
-    /** Getter for (Twilio.PreviewMessaging) domain */
-    get previewMessaging(): PreviewMessaging;
     /** Getter for (Twilio.Messaging) domain */
     get messaging(): Messaging;
     /** Getter for (Twilio.Microvisor) domain */

package/lib/rest/Twilio.js

@@ -45,7 +45,6 @@ class Twilio extends BaseTwilio_1.Client {
             this.intelligence;
             this.ipMessaging;
             this.lookups;
-            this.previewMessaging;
             this.messaging;
             this.microvisor;
             this.monitor;
@@ -127,11 +126,6 @@ class Twilio extends BaseTwilio_1.Client {
     get lookups() {
         return this._lookups ?? (this._lookups = new (require("./Lookups"))(this));
     }
-    /** Getter for (Twilio.PreviewMessaging) domain */
-    get previewMessaging() {
-        return (this._previewMessaging ??
-            (this._previewMessaging = new (require("./PreviewMessaging"))(this)));
-    }
     /** Getter for (Twilio.Messaging) domain */
     get messaging() {
         return (this._messaging ?? (this._messaging = new (require("./Messaging"))(this)));

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

@@ -15,15 +15,15 @@ export interface StreamContextUpdateOptions {
  * Options to pass to create a StreamInstance
  */
 export interface StreamListInstanceCreateOptions {
-    /** Relative or absolute url where WebSocket connection will be established. */
+    /** Relative or absolute URL where WebSocket connection will be established. */
     url: string;
-    /** The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream. */
+    /** The user-specified name of this Stream, if one was given when the Stream was created. This can be used to stop the Stream. */
     name?: string;
     /**  */
     track?: StreamTrack;
-    /** Absolute URL of the status callback. */
+    /** Absolute URL to which Twilio sends status callback HTTP requests. */
     statusCallback?: string;
-    /** The http method for the status_callback (one of GET, POST). */
+    /** The HTTP method Twilio uses when sending `status_callback` requests. Possible values are `GET` and `POST`. Default is `POST`. */
     statusCallbackMethod?: string;
     /** Parameter name */
     "parameter1.name"?: string;
@@ -484,7 +484,7 @@ export declare class StreamInstance {
      */
     callSid: string;
     /**
-     * The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream.
+     * The user-specified name of this Stream, if one was given when the Stream was created. This can be used to stop the Stream.
      */
     name: string;
     status: StreamStatus;

package/lib/rest/api/v2010/account/message.d.ts

@@ -274,7 +274,7 @@ export declare class MessageInstance {
     numMedia: string;
     status: MessageStatus;
     /**
-     * The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource. The value is `null` if a Messaging Service was not used.
+     * The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) associated with the Message resource. A unique default value is assigned if a Messaging Service is not used.
      */
     messagingServiceSid: string;
     /**

package/lib/rest/content/V2.d.ts

@@ -0,0 +1,20 @@
+import ContentBase from "../ContentBase";
+import Version from "../../base/Version";
+import { ContentListInstance } from "./v2/content";
+import { ContentAndApprovalsListInstance } from "./v2/contentAndApprovals";
+export default class V2 extends Version {
+    /**
+     * Initialize the V2 version of Content
+     *
+     * @param domain - The Twilio (Twilio.Content) domain
+     */
+    constructor(domain: ContentBase);
+    /** contents - { Twilio.Content.V2.ContentListInstance } resource */
+    protected _contents?: ContentListInstance;
+    /** contentAndApprovals - { Twilio.Content.V2.ContentAndApprovalsListInstance } resource */
+    protected _contentAndApprovals?: ContentAndApprovalsListInstance;
+    /** Getter for contents resource */
+    get contents(): ContentListInstance;
+    /** Getter for contentAndApprovals resource */
+    get contentAndApprovals(): ContentAndApprovalsListInstance;
+}

package/lib/rest/content/V2.js

@@ -0,0 +1,43 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Content
+ * This is the public Twilio REST API.
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Version_1 = __importDefault(require("../../base/Version"));
+const content_1 = require("./v2/content");
+const contentAndApprovals_1 = require("./v2/contentAndApprovals");
+class V2 extends Version_1.default {
+    /**
+     * Initialize the V2 version of Content
+     *
+     * @param domain - The Twilio (Twilio.Content) domain
+     */
+    constructor(domain) {
+        super(domain, "v2");
+    }
+    /** Getter for contents resource */
+    get contents() {
+        this._contents = this._contents || (0, content_1.ContentListInstance)(this);
+        return this._contents;
+    }
+    /** Getter for contentAndApprovals resource */
+    get contentAndApprovals() {
+        this._contentAndApprovals =
+            this._contentAndApprovals || (0, contentAndApprovals_1.ContentAndApprovalsListInstance)(this);
+        return this._contentAndApprovals;
+    }
+}
+exports.default = V2;

package/lib/rest/content/v2/content.d.ts

@@ -0,0 +1,196 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V2 from "../V2";
+/**
+ * Options to pass to each
+ */
+export interface ContentListInstanceEachOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: ContentInstance, done: (err?: Error) => void) => void;
+    /** Function to be called upon completion of streaming */
+    done?: Function;
+    /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to list
+ */
+export interface ContentListInstanceOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to page
+ */
+export interface ContentListInstancePageOptions {
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Page Number, this value is simply for client state */
+    pageNumber?: number;
+    /** PageToken provided by the API */
+    pageToken?: string;
+}
+export interface ContentSolution {
+}
+export interface ContentListInstance {
+    _version: V2;
+    _solution: ContentSolution;
+    _uri: string;
+    /**
+     * Streams ContentInstance 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.
+     *
+     * @param { ContentListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: ContentInstance, done: (err?: Error) => void) => void): void;
+    each(params: ContentListInstanceEachOptions, callback?: (item: ContentInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of ContentInstance records from the API.
+     *
+     * The request is executed immediately.
+     *
+     * @param { string } [targetUrl] - API-generated URL for the requested results page
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    getPage(targetUrl: string, callback?: (error: Error | null, items: ContentPage) => any): Promise<ContentPage>;
+    /**
+     * Lists ContentInstance records from the API as a list.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { ContentListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: ContentInstance[]) => any): Promise<ContentInstance[]>;
+    list(params: ContentListInstanceOptions, callback?: (error: Error | null, items: ContentInstance[]) => any): Promise<ContentInstance[]>;
+    /**
+     * Retrieve a single page of ContentInstance 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.
+     *
+     * @param { ContentListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: ContentPage) => any): Promise<ContentPage>;
+    page(params: ContentListInstancePageOptions, callback?: (error: Error | null, items: ContentPage) => any): Promise<ContentPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function ContentListInstance(version: V2): ContentListInstance;
+interface ContentPayload extends TwilioResponsePayload {
+    contents: ContentResource[];
+}
+interface ContentResource {
+    date_created: Date;
+    date_updated: Date;
+    sid: string;
+    account_sid: string;
+    friendly_name: string;
+    language: string;
+    variables: any;
+    types: any;
+    url: string;
+    links: Record<string, string>;
+}
+export declare class ContentInstance {
+    protected _version: V2;
+    constructor(_version: V2, payload: ContentResource);
+    /**
+     * The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+     */
+    dateUpdated: Date;
+    /**
+     * The unique string that that we created to identify the Content resource.
+     */
+    sid: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/usage/api/account) that created Content resource.
+     */
+    accountSid: string;
+    /**
+     * A string name used to describe the Content resource. Not visible to the end recipient.
+     */
+    friendlyName: string;
+    /**
+     * Two-letter (ISO 639-1) language code (e.g., en) identifying the language the Content resource is in.
+     */
+    language: string;
+    /**
+     * Defines the default placeholder values for variables included in the Content resource. e.g. {\"1\": \"Customer_Name\"}.
+     */
+    variables: any;
+    /**
+     * The [Content types](https://www.twilio.com/docs/content/content-types-overview) (e.g. twilio/text) for this Content resource.
+     */
+    types: any;
+    /**
+     * The URL of the resource, relative to `https://content.twilio.com`.
+     */
+    url: string;
+    /**
+     * A list of links related to the Content resource, such as approval_fetch and approval_create
+     */
+    links: Record<string, string>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        dateCreated: Date;
+        dateUpdated: Date;
+        sid: string;
+        accountSid: string;
+        friendlyName: string;
+        language: string;
+        variables: any;
+        types: any;
+        url: string;
+        links: Record<string, string>;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class ContentPage extends Page<V2, ContentPayload, ContentResource, ContentInstance> {
+    /**
+     * Initialize the ContentPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V2, response: Response<string>, solution: ContentSolution);
+    /**
+     * Build an instance of ContentInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: ContentResource): ContentInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/content/v2/content.js

@@ -0,0 +1,136 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Content
+ * This is the public Twilio REST API.
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentPage = exports.ContentInstance = exports.ContentListInstance = void 0;
+const util_1 = require("util");
+const Page_1 = __importDefault(require("../../../base/Page"));
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+function ContentListInstance(version) {
+    const instance = {};
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Content`;
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["PageSize"] = params["pageSize"];
+        if (params.pageNumber !== undefined)
+            data["Page"] = params.pageNumber;
+        if (params.pageToken !== undefined)
+            data["PageToken"] = params.pageToken;
+        const headers = {};
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new ContentPage(operationVersion, payload, instance._solution));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.list = instance._version.list;
+    instance.getPage = function getPage(targetUrl, callback) {
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((payload) => new ContentPage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    instance.toJSON = function toJSON() {
+        return instance._solution;
+    };
+    instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
+        return (0, util_1.inspect)(instance.toJSON(), options);
+    };
+    return instance;
+}
+exports.ContentListInstance = ContentListInstance;
+class ContentInstance {
+    constructor(_version, payload) {
+        this._version = _version;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this.sid = payload.sid;
+        this.accountSid = payload.account_sid;
+        this.friendlyName = payload.friendly_name;
+        this.language = payload.language;
+        this.variables = payload.variables;
+        this.types = payload.types;
+        this.url = payload.url;
+        this.links = payload.links;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+            sid: this.sid,
+            accountSid: this.accountSid,
+            friendlyName: this.friendlyName,
+            language: this.language,
+            variables: this.variables,
+            types: this.types,
+            url: this.url,
+            links: this.links,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ContentInstance = ContentInstance;
+class ContentPage extends Page_1.default {
+    /**
+     * Initialize the ContentPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version, response, solution) {
+        super(version, response, solution);
+    }
+    /**
+     * Build an instance of ContentInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new ContentInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ContentPage = ContentPage;