twilio 4.6.0 → 4.7.0

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

@@ -0,0 +1,305 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V1 from "../V1";
+type WebChannelChatStatus = "inactive";
+/**
+ * Options to pass to update a WebChannelInstance
+ */
+export interface WebChannelContextUpdateOptions {
+    /**  */
+    chatStatus?: WebChannelChatStatus;
+    /** The post-engagement data. */
+    postEngagementData?: string;
+}
+/**
+ * Options to pass to create a WebChannelInstance
+ */
+export interface WebChannelListInstanceCreateOptions {
+    /** The SID of the Flex Flow. */
+    flexFlowSid: string;
+    /** The chat identity. */
+    identity: string;
+    /** The chat participant\\\'s friendly name. */
+    customerFriendlyName: string;
+    /** The chat channel\\\'s friendly name. */
+    chatFriendlyName: string;
+    /** The chat channel\\\'s unique name. */
+    chatUniqueName?: string;
+    /** The pre-engagement data. */
+    preEngagementData?: string;
+}
+/**
+ * Options to pass to each
+ */
+export interface WebChannelListInstanceEachOptions {
+    /** 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: WebChannelInstance, 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 WebChannelListInstanceOptions {
+    /** 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 WebChannelListInstancePageOptions {
+    /** 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 WebChannelContext {
+    /**
+     * Remove a WebChannelInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a WebChannelInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelInstance
+     */
+    fetch(callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    /**
+     * Update a WebChannelInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelInstance
+     */
+    update(callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    /**
+     * Update a WebChannelInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelInstance
+     */
+    update(params: WebChannelContextUpdateOptions, callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface WebChannelContextSolution {
+    sid: string;
+}
+export declare class WebChannelContextImpl implements WebChannelContext {
+    protected _version: V1;
+    protected _solution: WebChannelContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, sid: string);
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    update(params?: WebChannelContextUpdateOptions | ((error: Error | null, item?: WebChannelInstance) => any), callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): WebChannelContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface WebChannelPayload extends TwilioResponsePayload {
+    flex_chat_channels: WebChannelResource[];
+}
+interface WebChannelResource {
+    account_sid: string;
+    flex_flow_sid: string;
+    sid: string;
+    url: string;
+    date_created: Date;
+    date_updated: Date;
+}
+export declare class WebChannelInstance {
+    protected _version: V1;
+    protected _solution: WebChannelContextSolution;
+    protected _context?: WebChannelContext;
+    constructor(_version: V1, payload: WebChannelResource, sid?: string);
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the WebChannel resource and owns this Workflow.
+     */
+    accountSid: string;
+    /**
+     * The SID of the Flex Flow.
+     */
+    flexFlowSid: string;
+    /**
+     * The unique string that we created to identify the WebChannel resource.
+     */
+    sid: string;
+    /**
+     * The absolute URL of the WebChannel resource.
+     */
+    url: string;
+    /**
+     * The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * 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;
+    private get _proxy();
+    /**
+     * Remove a WebChannelInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a WebChannelInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelInstance
+     */
+    fetch(callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    /**
+     * Update a WebChannelInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelInstance
+     */
+    update(callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    /**
+     * Update a WebChannelInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelInstance
+     */
+    update(params: WebChannelContextUpdateOptions, callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        flexFlowSid: string;
+        sid: string;
+        url: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface WebChannelSolution {
+}
+export interface WebChannelListInstance {
+    _version: V1;
+    _solution: WebChannelSolution;
+    _uri: string;
+    (sid: string): WebChannelContext;
+    get(sid: string): WebChannelContext;
+    /**
+     * Create a WebChannelInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelInstance
+     */
+    create(params: WebChannelListInstanceCreateOptions, callback?: (error: Error | null, item?: WebChannelInstance) => any): Promise<WebChannelInstance>;
+    /**
+     * Streams WebChannelInstance 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 { WebChannelListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: WebChannelInstance, done: (err?: Error) => void) => void): void;
+    each(params: WebChannelListInstanceEachOptions, callback?: (item: WebChannelInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of WebChannelInstance 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: WebChannelPage) => any): Promise<WebChannelPage>;
+    /**
+     * Lists WebChannelInstance 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 { WebChannelListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: WebChannelInstance[]) => any): Promise<WebChannelInstance[]>;
+    list(params: WebChannelListInstanceOptions, callback?: (error: Error | null, items: WebChannelInstance[]) => any): Promise<WebChannelInstance[]>;
+    /**
+     * Retrieve a single page of WebChannelInstance 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 { WebChannelListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: WebChannelPage) => any): Promise<WebChannelPage>;
+    page(params: WebChannelListInstancePageOptions, callback?: (error: Error | null, items: WebChannelPage) => any): Promise<WebChannelPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function WebChannelListInstance(version: V1): WebChannelListInstance;
+export declare class WebChannelPage extends Page<V1, WebChannelPayload, WebChannelResource, WebChannelInstance> {
+    /**
+     * Initialize the WebChannelPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: WebChannelSolution);
+    /**
+     * Build an instance of WebChannelInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: WebChannelResource): WebChannelInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,268 @@
+"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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebChannelPage = exports.WebChannelListInstance = exports.WebChannelInstance = exports.WebChannelContextImpl = void 0;
+const util_1 = require("util");
+const Page_1 = __importDefault(require("../../../base/Page"));
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class WebChannelContextImpl {
+    constructor(_version, sid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(sid)) {
+            throw new Error("Parameter 'sid' is not valid.");
+        }
+        this._solution = { sid };
+        this._uri = `/WebChannels/${sid}`;
+    }
+    remove(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.remove({
+            uri: instance._uri,
+            method: "delete",
+        });
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new WebChannelInstance(operationVersion, payload, instance._solution.sid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    update(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["chatStatus"] !== undefined)
+            data["ChatStatus"] = params["chatStatus"];
+        if (params["postEngagementData"] !== undefined)
+            data["PostEngagementData"] = params["postEngagementData"];
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new WebChannelInstance(operationVersion, payload, instance._solution.sid));
+        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.WebChannelContextImpl = WebChannelContextImpl;
+class WebChannelInstance {
+    constructor(_version, payload, sid) {
+        this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.flexFlowSid = payload.flex_flow_sid;
+        this.sid = payload.sid;
+        this.url = payload.url;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this._solution = { sid: sid || this.sid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new WebChannelContextImpl(this._version, this._solution.sid);
+        return this._context;
+    }
+    /**
+     * Remove a WebChannelInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a WebChannelInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    update(params, callback) {
+        return this._proxy.update(params, callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accountSid: this.accountSid,
+            flexFlowSid: this.flexFlowSid,
+            sid: this.sid,
+            url: this.url,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.WebChannelInstance = WebChannelInstance;
+function WebChannelListInstance(version) {
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new WebChannelContextImpl(version, sid);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/WebChannels`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["flexFlowSid"] === null || params["flexFlowSid"] === undefined) {
+            throw new Error("Required parameter \"params['flexFlowSid']\" missing.");
+        }
+        if (params["identity"] === null || params["identity"] === undefined) {
+            throw new Error("Required parameter \"params['identity']\" missing.");
+        }
+        if (params["customerFriendlyName"] === null ||
+            params["customerFriendlyName"] === undefined) {
+            throw new Error("Required parameter \"params['customerFriendlyName']\" missing.");
+        }
+        if (params["chatFriendlyName"] === null ||
+            params["chatFriendlyName"] === undefined) {
+            throw new Error("Required parameter \"params['chatFriendlyName']\" missing.");
+        }
+        let data = {};
+        data["FlexFlowSid"] = params["flexFlowSid"];
+        data["Identity"] = params["identity"];
+        data["CustomerFriendlyName"] = params["customerFriendlyName"];
+        data["ChatFriendlyName"] = params["chatFriendlyName"];
+        if (params["chatUniqueName"] !== undefined)
+            data["ChatUniqueName"] = params["chatUniqueName"];
+        if (params["preEngagementData"] !== undefined)
+            data["PreEngagementData"] = params["preEngagementData"];
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new WebChannelInstance(operationVersion, payload));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    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 WebChannelPage(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 WebChannelPage(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.WebChannelListInstance = WebChannelListInstance;
+class WebChannelPage extends Page_1.default {
+    /**
+     * Initialize the WebChannelPage
+     *
+     * @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 WebChannelInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new WebChannelInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.WebChannelPage = WebChannelPage;

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

@@ -0,0 +1,65 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+/**
+ * Options to pass to create a WebChannelsInstance
+ */
+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 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. */
+    customerFriendlyName?: string;
+    /** The pre-engagement data. */
+    preEngagementData?: string;
+}
+export interface WebChannelsSolution {
+}
+export interface WebChannelsListInstance {
+    _version: V2;
+    _solution: WebChannelsSolution;
+    _uri: string;
+    /**
+     * Create a WebChannelsInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed WebChannelsInstance
+     */
+    create(params: WebChannelsListInstanceCreateOptions, callback?: (error: Error | null, item?: WebChannelsInstance) => any): Promise<WebChannelsInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function WebChannelsListInstance(version: V2): WebChannelsListInstance;
+interface WebChannelsResource {
+    conversation_sid: string;
+    identity: string;
+}
+export declare class WebChannelsInstance {
+    protected _version: V2;
+    constructor(_version: V2, payload: WebChannelsResource);
+    /**
+     * The unique string representing the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource) created.
+     */
+    conversationSid: string;
+    /**
+     * The unique string representing the User created and should be authorized to participate in the Conversation. For more details, see [User Identity & Access Tokens](https://www.twilio.com/docs/conversations/identity).
+     */
+    identity: string;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        conversationSid: string;
+        identity: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export {};