twilio 5.0.3 → 5.1.0

package/lib/rest/flexApi/v2/flexUser.js

@@ -0,0 +1,142 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Flex
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlexUserListInstance = exports.FlexUserInstance = exports.FlexUserContextImpl = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class FlexUserContextImpl {
+    constructor(_version, instanceSid, flexUserSid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(instanceSid)) {
+            throw new Error("Parameter 'instanceSid' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(flexUserSid)) {
+            throw new Error("Parameter 'flexUserSid' is not valid.");
+        }
+        this._solution = { instanceSid, flexUserSid };
+        this._uri = `/Instances/${instanceSid}/Users/${flexUserSid}`;
+    }
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new FlexUserInstance(operationVersion, payload, instance._solution.instanceSid, instance._solution.flexUserSid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return this._solution;
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.FlexUserContextImpl = FlexUserContextImpl;
+class FlexUserInstance {
+    constructor(_version, payload, instanceSid, flexUserSid) {
+        this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.instanceSid = payload.instance_sid;
+        this.userSid = payload.user_sid;
+        this.flexUserSid = payload.flex_user_sid;
+        this.workerSid = payload.worker_sid;
+        this.workspaceSid = payload.workspace_sid;
+        this.flexTeamSid = payload.flex_team_sid;
+        this.firstName = payload.first_name;
+        this.lastName = payload.last_name;
+        this.username = payload.username;
+        this.email = payload.email;
+        this.friendlyName = payload.friendly_name;
+        this.createdDate = deserialize.iso8601DateTime(payload.created_date);
+        this.updatedDate = deserialize.iso8601DateTime(payload.updated_date);
+        this.version = deserialize.integer(payload.version);
+        this.url = payload.url;
+        this._solution = {
+            instanceSid: instanceSid || this.instanceSid,
+            flexUserSid: flexUserSid || this.flexUserSid,
+        };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new FlexUserContextImpl(this._version, this._solution.instanceSid, this._solution.flexUserSid);
+        return this._context;
+    }
+    /**
+     * Fetch a FlexUserInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FlexUserInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accountSid: this.accountSid,
+            instanceSid: this.instanceSid,
+            userSid: this.userSid,
+            flexUserSid: this.flexUserSid,
+            workerSid: this.workerSid,
+            workspaceSid: this.workspaceSid,
+            flexTeamSid: this.flexTeamSid,
+            firstName: this.firstName,
+            lastName: this.lastName,
+            username: this.username,
+            email: this.email,
+            friendlyName: this.friendlyName,
+            createdDate: this.createdDate,
+            updatedDate: this.updatedDate,
+            version: this.version,
+            url: this.url,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.FlexUserInstance = FlexUserInstance;
+function FlexUserListInstance(version) {
+    const instance = ((instanceSid, flexUserSid) => instance.get(instanceSid, flexUserSid));
+    instance.get = function get(instanceSid, flexUserSid) {
+        return new FlexUserContextImpl(version, instanceSid, flexUserSid);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = ``;
+    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.FlexUserListInstance = FlexUserListInstance;

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

@@ -7,6 +7,8 @@ import V2 from "../V2";
 export interface WebChannelsListInstanceCreateOptions {
     /** The SID of the Conversations Address. See [Address Configuration Resource](https://www.twilio.com/docs/conversations/api/address-configuration-resource) for configuration details. When a conversation is created on the Flex backend, the callback URL will be set to the corresponding Studio Flow SID or webhook URL in your address configuration. */
     addressSid: string;
+    /** The Ui-Version HTTP request header */
+    uiVersion?: string;
     /** The Conversation\\\'s friendly name. See the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource) for an example. */
     chatFriendlyName?: string;
     /** The Conversation participant\\\'s friendly name. See the [Conversation Participant Resource](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) for an example. */

package/lib/rest/flexApi/v2/webChannels.js

@@ -39,6 +39,8 @@ function WebChannelsListInstance(version) {
             data["PreEngagementData"] = params["preEngagementData"];
         const headers = {};
         headers["Content-Type"] = "application/x-www-form-urlencoded";
+        if (params["uiVersion"] !== undefined)
+            headers["Ui-Version"] = params["uiVersion"];
         let operationVersion = version, operationPromise = operationVersion.create({
             uri: instance._uri,
             method: "post",

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

@@ -1,5 +1,11 @@
 import IntelligenceBase from "../IntelligenceBase";
 import Version from "../../base/Version";
+import { CustomOperatorListInstance } from "./v2/customOperator";
+import { OperatorListInstance } from "./v2/operator";
+import { OperatorAttachmentListInstance } from "./v2/operatorAttachment";
+import { OperatorAttachmentsListInstance } from "./v2/operatorAttachments";
+import { OperatorTypeListInstance } from "./v2/operatorType";
+import { PrebuiltOperatorListInstance } from "./v2/prebuiltOperator";
 import { ServiceListInstance } from "./v2/service";
 import { TranscriptListInstance } from "./v2/transcript";
 export default class V2 extends Version {
@@ -9,10 +15,34 @@ export default class V2 extends Version {
      * @param domain - The Twilio (Twilio.Intelligence) domain
      */
     constructor(domain: IntelligenceBase);
+    /** customOperators - { Twilio.Intelligence.V2.CustomOperatorListInstance } resource */
+    protected _customOperators?: CustomOperatorListInstance;
+    /** operators - { Twilio.Intelligence.V2.OperatorListInstance } resource */
+    protected _operators?: OperatorListInstance;
+    /** operatorAttachment - { Twilio.Intelligence.V2.OperatorAttachmentListInstance } resource */
+    protected _operatorAttachment?: OperatorAttachmentListInstance;
+    /** operatorAttachments - { Twilio.Intelligence.V2.OperatorAttachmentsListInstance } resource */
+    protected _operatorAttachments?: OperatorAttachmentsListInstance;
+    /** operatorType - { Twilio.Intelligence.V2.OperatorTypeListInstance } resource */
+    protected _operatorType?: OperatorTypeListInstance;
+    /** prebuiltOperators - { Twilio.Intelligence.V2.PrebuiltOperatorListInstance } resource */
+    protected _prebuiltOperators?: PrebuiltOperatorListInstance;
     /** services - { Twilio.Intelligence.V2.ServiceListInstance } resource */
     protected _services?: ServiceListInstance;
     /** transcripts - { Twilio.Intelligence.V2.TranscriptListInstance } resource */
     protected _transcripts?: TranscriptListInstance;
+    /** Getter for customOperators resource */
+    get customOperators(): CustomOperatorListInstance;
+    /** Getter for operators resource */
+    get operators(): OperatorListInstance;
+    /** Getter for operatorAttachment resource */
+    get operatorAttachment(): OperatorAttachmentListInstance;
+    /** Getter for operatorAttachments resource */
+    get operatorAttachments(): OperatorAttachmentsListInstance;
+    /** Getter for operatorType resource */
+    get operatorType(): OperatorTypeListInstance;
+    /** Getter for prebuiltOperators resource */
+    get prebuiltOperators(): PrebuiltOperatorListInstance;
     /** Getter for services resource */
     get services(): ServiceListInstance;
     /** Getter for transcripts resource */

package/lib/rest/intelligence/V2.js

@@ -17,6 +17,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Version_1 = __importDefault(require("../../base/Version"));
+const customOperator_1 = require("./v2/customOperator");
+const operator_1 = require("./v2/operator");
+const operatorAttachment_1 = require("./v2/operatorAttachment");
+const operatorAttachments_1 = require("./v2/operatorAttachments");
+const operatorType_1 = require("./v2/operatorType");
+const prebuiltOperator_1 = require("./v2/prebuiltOperator");
 const service_1 = require("./v2/service");
 const transcript_1 = require("./v2/transcript");
 class V2 extends Version_1.default {
@@ -28,6 +34,40 @@ class V2 extends Version_1.default {
     constructor(domain) {
         super(domain, "v2");
     }
+    /** Getter for customOperators resource */
+    get customOperators() {
+        this._customOperators =
+            this._customOperators || (0, customOperator_1.CustomOperatorListInstance)(this);
+        return this._customOperators;
+    }
+    /** Getter for operators resource */
+    get operators() {
+        this._operators = this._operators || (0, operator_1.OperatorListInstance)(this);
+        return this._operators;
+    }
+    /** Getter for operatorAttachment resource */
+    get operatorAttachment() {
+        this._operatorAttachment =
+            this._operatorAttachment || (0, operatorAttachment_1.OperatorAttachmentListInstance)(this);
+        return this._operatorAttachment;
+    }
+    /** Getter for operatorAttachments resource */
+    get operatorAttachments() {
+        this._operatorAttachments =
+            this._operatorAttachments || (0, operatorAttachments_1.OperatorAttachmentsListInstance)(this);
+        return this._operatorAttachments;
+    }
+    /** Getter for operatorType resource */
+    get operatorType() {
+        this._operatorType = this._operatorType || (0, operatorType_1.OperatorTypeListInstance)(this);
+        return this._operatorType;
+    }
+    /** Getter for prebuiltOperators resource */
+    get prebuiltOperators() {
+        this._prebuiltOperators =
+            this._prebuiltOperators || (0, prebuiltOperator_1.PrebuiltOperatorListInstance)(this);
+        return this._prebuiltOperators;
+    }
     /** Getter for services resource */
     get services() {
         this._services = this._services || (0, service_1.ServiceListInstance)(this);

package/lib/rest/intelligence/v2/customOperator.d.ts

@@ -0,0 +1,330 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V2 from "../V2";
+export type CustomOperatorAvailability = "internal" | "beta" | "public" | "retired";
+/**
+ * Options to pass to update a CustomOperatorInstance
+ */
+export interface CustomOperatorContextUpdateOptions {
+    /** A human-readable name of this resource, up to 64 characters. */
+    friendlyName: string;
+    /** Operator configuration, following the schema defined by the Operator Type. */
+    config: any;
+    /** The If-Match HTTP request header */
+    ifMatch?: string;
+}
+/**
+ * Options to pass to create a CustomOperatorInstance
+ */
+export interface CustomOperatorListInstanceCreateOptions {
+    /** A human readable description of the new Operator, up to 64 characters. */
+    friendlyName: string;
+    /** Operator Type for this Operator. References an existing Operator Type resource. */
+    operatorType: string;
+    /** Operator configuration, following the schema defined by the Operator Type. */
+    config: any;
+}
+/**
+ * Options to pass to each
+ */
+export interface CustomOperatorListInstanceEachOptions {
+    /** Returns Custom Operators with the provided availability type. Possible values: internal, beta, public, retired. */
+    availability?: CustomOperatorAvailability;
+    /** Returns Custom Operators that support the provided language code. */
+    languageCode?: string;
+    /** 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: CustomOperatorInstance, 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 CustomOperatorListInstanceOptions {
+    /** Returns Custom Operators with the provided availability type. Possible values: internal, beta, public, retired. */
+    availability?: CustomOperatorAvailability;
+    /** Returns Custom Operators that support the provided language code. */
+    languageCode?: string;
+    /** 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 CustomOperatorListInstancePageOptions {
+    /** Returns Custom Operators with the provided availability type. Possible values: internal, beta, public, retired. */
+    availability?: CustomOperatorAvailability;
+    /** Returns Custom Operators that support the provided language code. */
+    languageCode?: string;
+    /** 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 CustomOperatorContext {
+    /**
+     * Remove a CustomOperatorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a CustomOperatorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed CustomOperatorInstance
+     */
+    fetch(callback?: (error: Error | null, item?: CustomOperatorInstance) => any): Promise<CustomOperatorInstance>;
+    /**
+     * Update a CustomOperatorInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed CustomOperatorInstance
+     */
+    update(params: CustomOperatorContextUpdateOptions, callback?: (error: Error | null, item?: CustomOperatorInstance) => any): Promise<CustomOperatorInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface CustomOperatorContextSolution {
+    sid: string;
+}
+export declare class CustomOperatorContextImpl implements CustomOperatorContext {
+    protected _version: V2;
+    protected _solution: CustomOperatorContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, sid: string);
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: CustomOperatorInstance) => any): Promise<CustomOperatorInstance>;
+    update(params: CustomOperatorContextUpdateOptions, callback?: (error: Error | null, item?: CustomOperatorInstance) => any): Promise<CustomOperatorInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): CustomOperatorContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface CustomOperatorPayload extends TwilioResponsePayload {
+    operators: CustomOperatorResource[];
+}
+interface CustomOperatorResource {
+    account_sid: string;
+    sid: string;
+    friendly_name: string;
+    description: string;
+    author: string;
+    operator_type: string;
+    version: number;
+    availability: CustomOperatorAvailability;
+    config: any;
+    date_created: Date;
+    date_updated: Date;
+    url: string;
+}
+export declare class CustomOperatorInstance {
+    protected _version: V2;
+    protected _solution: CustomOperatorContextSolution;
+    protected _context?: CustomOperatorContext;
+    constructor(_version: V2, payload: CustomOperatorResource, sid?: string);
+    /**
+     * The unique SID identifier of the Account the Custom Operator belongs to.
+     */
+    accountSid: string;
+    /**
+     * A 34 character string that uniquely identifies this Custom Operator.
+     */
+    sid: string;
+    /**
+     * A human-readable name of this resource, up to 64 characters.
+     */
+    friendlyName: string;
+    /**
+     * A human-readable description of this resource, longer than the friendly name.
+     */
+    description: string;
+    /**
+     * The creator of the Custom Operator. Custom Operators can only be created by a Twilio Account.
+     */
+    author: string;
+    /**
+     * Operator Type for this Operator. References an existing Operator Type resource.
+     */
+    operatorType: string;
+    /**
+     * Numeric Custom Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Custom Operator.
+     */
+    version: number;
+    availability: CustomOperatorAvailability;
+    /**
+     * Operator configuration, following the schema defined by the Operator Type. Only available on Operators created by the Account.
+     */
+    config: any;
+    /**
+     * The date that this Custom Operator was created, given in ISO 8601 format.
+     */
+    dateCreated: Date;
+    /**
+     * The date that this Custom Operator was updated, given in ISO 8601 format.
+     */
+    dateUpdated: Date;
+    /**
+     * The URL of this resource.
+     */
+    url: string;
+    private get _proxy();
+    /**
+     * Remove a CustomOperatorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a CustomOperatorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed CustomOperatorInstance
+     */
+    fetch(callback?: (error: Error | null, item?: CustomOperatorInstance) => any): Promise<CustomOperatorInstance>;
+    /**
+     * Update a CustomOperatorInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed CustomOperatorInstance
+     */
+    update(params: CustomOperatorContextUpdateOptions, callback?: (error: Error | null, item?: CustomOperatorInstance) => any): Promise<CustomOperatorInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        sid: string;
+        friendlyName: string;
+        description: string;
+        author: string;
+        operatorType: string;
+        version: number;
+        availability: CustomOperatorAvailability;
+        config: any;
+        dateCreated: Date;
+        dateUpdated: Date;
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface CustomOperatorSolution {
+}
+export interface CustomOperatorListInstance {
+    _version: V2;
+    _solution: CustomOperatorSolution;
+    _uri: string;
+    (sid: string): CustomOperatorContext;
+    get(sid: string): CustomOperatorContext;
+    /**
+     * Create a CustomOperatorInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed CustomOperatorInstance
+     */
+    create(params: CustomOperatorListInstanceCreateOptions, callback?: (error: Error | null, item?: CustomOperatorInstance) => any): Promise<CustomOperatorInstance>;
+    /**
+     * Streams CustomOperatorInstance 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 { CustomOperatorListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: CustomOperatorInstance, done: (err?: Error) => void) => void): void;
+    each(params: CustomOperatorListInstanceEachOptions, callback?: (item: CustomOperatorInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of CustomOperatorInstance 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: CustomOperatorPage) => any): Promise<CustomOperatorPage>;
+    /**
+     * Lists CustomOperatorInstance 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 { CustomOperatorListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: CustomOperatorInstance[]) => any): Promise<CustomOperatorInstance[]>;
+    list(params: CustomOperatorListInstanceOptions, callback?: (error: Error | null, items: CustomOperatorInstance[]) => any): Promise<CustomOperatorInstance[]>;
+    /**
+     * Retrieve a single page of CustomOperatorInstance 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 { CustomOperatorListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: CustomOperatorPage) => any): Promise<CustomOperatorPage>;
+    page(params: CustomOperatorListInstancePageOptions, callback?: (error: Error | null, items: CustomOperatorPage) => any): Promise<CustomOperatorPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function CustomOperatorListInstance(version: V2): CustomOperatorListInstance;
+export declare class CustomOperatorPage extends Page<V2, CustomOperatorPayload, CustomOperatorResource, CustomOperatorInstance> {
+    /**
+     * Initialize the CustomOperatorPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V2, response: Response<string>, solution: CustomOperatorSolution);
+    /**
+     * Build an instance of CustomOperatorInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: CustomOperatorResource): CustomOperatorInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};