twilio 5.0.3 → 5.1.0

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

@@ -0,0 +1,190 @@
+/// <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 ContentAndApprovalsListInstanceEachOptions {
+    /** 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: ContentAndApprovalsInstance, 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 ContentAndApprovalsListInstanceOptions {
+    /** 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 ContentAndApprovalsListInstancePageOptions {
+    /** 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 ContentAndApprovalsSolution {
+}
+export interface ContentAndApprovalsListInstance {
+    _version: V2;
+    _solution: ContentAndApprovalsSolution;
+    _uri: string;
+    /**
+     * Streams ContentAndApprovalsInstance 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 { ContentAndApprovalsListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: ContentAndApprovalsInstance, done: (err?: Error) => void) => void): void;
+    each(params: ContentAndApprovalsListInstanceEachOptions, callback?: (item: ContentAndApprovalsInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of ContentAndApprovalsInstance 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: ContentAndApprovalsPage) => any): Promise<ContentAndApprovalsPage>;
+    /**
+     * Lists ContentAndApprovalsInstance 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 { ContentAndApprovalsListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: ContentAndApprovalsInstance[]) => any): Promise<ContentAndApprovalsInstance[]>;
+    list(params: ContentAndApprovalsListInstanceOptions, callback?: (error: Error | null, items: ContentAndApprovalsInstance[]) => any): Promise<ContentAndApprovalsInstance[]>;
+    /**
+     * Retrieve a single page of ContentAndApprovalsInstance 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 { ContentAndApprovalsListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: ContentAndApprovalsPage) => any): Promise<ContentAndApprovalsPage>;
+    page(params: ContentAndApprovalsListInstancePageOptions, callback?: (error: Error | null, items: ContentAndApprovalsPage) => any): Promise<ContentAndApprovalsPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function ContentAndApprovalsListInstance(version: V2): ContentAndApprovalsListInstance;
+interface ContentAndApprovalsPayload extends TwilioResponsePayload {
+    contents: ContentAndApprovalsResource[];
+}
+interface ContentAndApprovalsResource {
+    date_created: Date;
+    date_updated: Date;
+    sid: string;
+    account_sid: string;
+    friendly_name: string;
+    language: string;
+    variables: any;
+    types: any;
+    approval_requests: any;
+}
+export declare class ContentAndApprovalsInstance {
+    protected _version: V2;
+    constructor(_version: V2, payload: ContentAndApprovalsResource);
+    /**
+     * 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 submitted information and approval request status of the Content resource.
+     */
+    approvalRequests: any;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        dateCreated: Date;
+        dateUpdated: Date;
+        sid: string;
+        accountSid: string;
+        friendlyName: string;
+        language: string;
+        variables: any;
+        types: any;
+        approvalRequests: any;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class ContentAndApprovalsPage extends Page<V2, ContentAndApprovalsPayload, ContentAndApprovalsResource, ContentAndApprovalsInstance> {
+    /**
+     * Initialize the ContentAndApprovalsPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V2, response: Response<string>, solution: ContentAndApprovalsSolution);
+    /**
+     * Build an instance of ContentAndApprovalsInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: ContentAndApprovalsResource): ContentAndApprovalsInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,134 @@
+"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.ContentAndApprovalsPage = exports.ContentAndApprovalsInstance = exports.ContentAndApprovalsListInstance = 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 ContentAndApprovalsListInstance(version) {
+    const instance = {};
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/ContentAndApprovals`;
+    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 ContentAndApprovalsPage(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 ContentAndApprovalsPage(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.ContentAndApprovalsListInstance = ContentAndApprovalsListInstance;
+class ContentAndApprovalsInstance {
+    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.approvalRequests = payload.approval_requests;
+    }
+    /**
+     * 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,
+            approvalRequests: this.approvalRequests,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ContentAndApprovalsInstance = ContentAndApprovalsInstance;
+class ContentAndApprovalsPage extends Page_1.default {
+    /**
+     * Initialize the ContentAndApprovalsPage
+     *
+     * @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 ContentAndApprovalsInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new ContentAndApprovalsInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ContentAndApprovalsPage = ContentAndApprovalsPage;

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

@@ -1,5 +1,6 @@
 import FlexApiBase from "../FlexApiBase";
 import Version from "../../base/Version";
+import { FlexUserListInstance } from "./v2/flexUser";
 import { WebChannelsListInstance } from "./v2/webChannels";
 export default class V2 extends Version {
     /**
@@ -8,8 +9,12 @@ export default class V2 extends Version {
      * @param domain - The Twilio (Twilio.FlexApi) domain
      */
     constructor(domain: FlexApiBase);
+    /** flexUser - { Twilio.FlexApi.V2.FlexUserListInstance } resource */
+    protected _flexUser?: FlexUserListInstance;
     /** webChannels - { Twilio.FlexApi.V2.WebChannelsListInstance } resource */
     protected _webChannels?: WebChannelsListInstance;
+    /** Getter for flexUser resource */
+    get flexUser(): FlexUserListInstance;
     /** Getter for webChannels resource */
     get webChannels(): WebChannelsListInstance;
 }

package/lib/rest/flexApi/V2.js

@@ -17,6 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Version_1 = __importDefault(require("../../base/Version"));
+const flexUser_1 = require("./v2/flexUser");
 const webChannels_1 = require("./v2/webChannels");
 class V2 extends Version_1.default {
     /**
@@ -27,6 +28,11 @@ class V2 extends Version_1.default {
     constructor(domain) {
         super(domain, "v2");
     }
+    /** Getter for flexUser resource */
+    get flexUser() {
+        this._flexUser = this._flexUser || (0, flexUser_1.FlexUserListInstance)(this);
+        return this._flexUser;
+    }
     /** Getter for webChannels resource */
     get webChannels() {
         this._webChannels = this._webChannels || (0, webChannels_1.WebChannelsListInstance)(this);

package/lib/rest/flexApi/v1/interaction.d.ts

@@ -9,7 +9,7 @@ export interface InteractionListInstanceCreateOptions {
     /** The Interaction\\\'s channel. */
     channel: any;
     /** The Interaction\\\'s routing logic. */
-    routing: any;
+    routing?: any;
     /** The Interaction context sid is used for adding a context lookup sid */
     interactionContextSid?: string;
 }

package/lib/rest/flexApi/v1/interaction.js

@@ -125,12 +125,10 @@ function InteractionListInstance(version) {
         if (params["channel"] === null || params["channel"] === undefined) {
             throw new Error("Required parameter \"params['channel']\" missing.");
         }
-        if (params["routing"] === null || params["routing"] === undefined) {
-            throw new Error("Required parameter \"params['routing']\" missing.");
-        }
         let data = {};
         data["Channel"] = serialize.object(params["channel"]);
-        data["Routing"] = serialize.object(params["routing"]);
+        if (params["routing"] !== undefined)
+            data["Routing"] = serialize.object(params["routing"]);
         if (params["interactionContextSid"] !== undefined)
             data["InteractionContextSid"] = params["interactionContextSid"];
         const headers = {};

package/lib/rest/flexApi/v1/plugin/pluginVersions.d.ts

@@ -122,6 +122,7 @@ interface PluginVersionsResource {
     changelog: string;
     private: boolean;
     archived: boolean;
+    validated: boolean;
     date_created: Date;
     url: string;
 }
@@ -155,13 +156,14 @@ export declare class PluginVersionsInstance {
      */
     changelog: string;
     /**
-     * Whether to inject credentials while accessing this Plugin Version. The default value is false.
+     * Whether the Flex Plugin Version is validated. The default value is false.
      */
     _private: boolean;
     /**
      * Whether the Flex Plugin Version is archived. The default value is false.
      */
     archived: boolean;
+    validated: boolean;
     /**
      * The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
      */
@@ -202,6 +204,7 @@ export declare class PluginVersionsInstance {
         changelog: string;
         _private: boolean;
         archived: boolean;
+        validated: boolean;
         dateCreated: Date;
         url: string;
     };

package/lib/rest/flexApi/v1/plugin/pluginVersions.js

@@ -81,6 +81,7 @@ class PluginVersionsInstance {
         this.changelog = payload.changelog;
         this._private = payload.private;
         this.archived = payload.archived;
+        this.validated = payload.validated;
         this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
         this.url = payload.url;
         this._solution = { pluginSid, sid: sid || this.sid };
@@ -109,6 +110,7 @@ class PluginVersionsInstance {
             changelog: this.changelog,
             _private: this._private,
             archived: this.archived,
+            validated: this.validated,
             dateCreated: this.dateCreated,
             url: this.url,
         };

package/lib/rest/flexApi/v2/flexUser.d.ts

@@ -0,0 +1,170 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+export interface FlexUserContext {
+    /**
+     * Fetch a FlexUserInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FlexUserInstance
+     */
+    fetch(callback?: (error: Error | null, item?: FlexUserInstance) => any): Promise<FlexUserInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface FlexUserContextSolution {
+    instanceSid: string;
+    flexUserSid: string;
+}
+export declare class FlexUserContextImpl implements FlexUserContext {
+    protected _version: V2;
+    protected _solution: FlexUserContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, instanceSid: string, flexUserSid: string);
+    fetch(callback?: (error: Error | null, item?: FlexUserInstance) => any): Promise<FlexUserInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): FlexUserContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface FlexUserResource {
+    account_sid: string;
+    instance_sid: string;
+    user_sid: string;
+    flex_user_sid: string;
+    worker_sid: string;
+    workspace_sid: string;
+    flex_team_sid: string;
+    first_name: string;
+    last_name: string;
+    username: string;
+    email: string;
+    friendly_name: string;
+    created_date: Date;
+    updated_date: Date;
+    version: number;
+    url: string;
+}
+export declare class FlexUserInstance {
+    protected _version: V2;
+    protected _solution: FlexUserContextSolution;
+    protected _context?: FlexUserContext;
+    constructor(_version: V2, payload: FlexUserResource, instanceSid?: string, flexUserSid?: string);
+    /**
+     * The unique SID of the account that created the resource.
+     */
+    accountSid: string;
+    /**
+     * The unique ID created by Twilio to identify a Flex instance.
+     */
+    instanceSid: string;
+    /**
+     * The unique SID identifier of the Twilio Unified User.
+     */
+    userSid: string;
+    /**
+     * The unique SID identifier of the Flex User.
+     */
+    flexUserSid: string;
+    /**
+     * The unique SID identifier of the worker.
+     */
+    workerSid: string;
+    /**
+     * The unique SID identifier of the workspace.
+     */
+    workspaceSid: string;
+    /**
+     * The unique SID identifier of the Flex Team.
+     */
+    flexTeamSid: string;
+    /**
+     * First name of the User.
+     */
+    firstName: string;
+    /**
+     * Last name of the User.
+     */
+    lastName: string;
+    /**
+     * Username of the User.
+     */
+    username: string;
+    /**
+     * Email of the User.
+     */
+    email: string;
+    /**
+     * Friendly name of the User.
+     */
+    friendlyName: string;
+    /**
+     * The date that this user was created, given in ISO 8601 format.
+     */
+    createdDate: Date;
+    /**
+     * The date that this user was updated, given in ISO 8601 format.
+     */
+    updatedDate: Date;
+    /**
+     * The current version of the user.
+     */
+    version: number;
+    url: string;
+    private get _proxy();
+    /**
+     * Fetch a FlexUserInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FlexUserInstance
+     */
+    fetch(callback?: (error: Error | null, item?: FlexUserInstance) => any): Promise<FlexUserInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        instanceSid: string;
+        userSid: string;
+        flexUserSid: string;
+        workerSid: string;
+        workspaceSid: string;
+        flexTeamSid: string;
+        firstName: string;
+        lastName: string;
+        username: string;
+        email: string;
+        friendlyName: string;
+        createdDate: Date;
+        updatedDate: Date;
+        version: number;
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface FlexUserSolution {
+}
+export interface FlexUserListInstance {
+    _version: V2;
+    _solution: FlexUserSolution;
+    _uri: string;
+    (instanceSid: string, flexUserSid: string): FlexUserContext;
+    get(instanceSid: string, flexUserSid: string): FlexUserContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function FlexUserListInstance(version: V2): FlexUserListInstance;
+export {};