twilio 4.6.0 → 4.7.0

package/lib/rest/studio/v1/flow/engagement.d.ts

@@ -0,0 +1,300 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import V1 from "../../V1";
+import { EngagementContextListInstance } from "./engagement/engagementContext";
+import { StepListInstance } from "./engagement/step";
+type EngagementStatus = "active" | "ended";
+/**
+ * Options to pass to create a EngagementInstance
+ */
+export interface EngagementListInstanceCreateOptions {
+    /** The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`. */
+    to: string;
+    /** The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}` */
+    from: string;
+    /** A JSON string we will add to your flow\\\'s context and that you can access as variables inside your flow. For example, if you pass in `Parameters={\\\'name\\\':\\\'Zeke\\\'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string \\\'Zeke\\\'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string. */
+    parameters?: any;
+}
+/**
+ * Options to pass to each
+ */
+export interface EngagementListInstanceEachOptions {
+    /** 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: EngagementInstance, 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 EngagementListInstanceOptions {
+    /** 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 EngagementListInstancePageOptions {
+    /** 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 EngagementContext {
+    engagementContext: EngagementContextListInstance;
+    steps: StepListInstance;
+    /**
+     * Remove a EngagementInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a EngagementInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed EngagementInstance
+     */
+    fetch(callback?: (error: Error | null, item?: EngagementInstance) => any): Promise<EngagementInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface EngagementContextSolution {
+    flowSid: string;
+    sid: string;
+}
+export declare class EngagementContextImpl implements EngagementContext {
+    protected _version: V1;
+    protected _solution: EngagementContextSolution;
+    protected _uri: string;
+    protected _engagementContext?: EngagementContextListInstance;
+    protected _steps?: StepListInstance;
+    constructor(_version: V1, flowSid: string, sid: string);
+    get engagementContext(): EngagementContextListInstance;
+    get steps(): StepListInstance;
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: EngagementInstance) => any): Promise<EngagementInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): EngagementContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface EngagementPayload extends TwilioResponsePayload {
+    engagements: EngagementResource[];
+}
+interface EngagementResource {
+    sid: string;
+    account_sid: string;
+    flow_sid: string;
+    contact_sid: string;
+    contact_channel_address: string;
+    context: any;
+    status: EngagementStatus;
+    date_created: Date;
+    date_updated: Date;
+    url: string;
+    links: Record<string, string>;
+}
+export declare class EngagementInstance {
+    protected _version: V1;
+    protected _solution: EngagementContextSolution;
+    protected _context?: EngagementContext;
+    constructor(_version: V1, payload: EngagementResource, flowSid: string, sid?: string);
+    /**
+     * The unique string that we created to identify the Engagement resource.
+     */
+    sid: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Engagement resource.
+     */
+    accountSid: string;
+    /**
+     * The SID of the Flow.
+     */
+    flowSid: string;
+    /**
+     * The SID of the Contact.
+     */
+    contactSid: string;
+    /**
+     * The phone number, SIP address or Client identifier that triggered this Engagement. Phone numbers are in E.164 format (+16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`.
+     */
+    contactChannelAddress: string;
+    /**
+     * The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution.
+     */
+    context: any;
+    status: EngagementStatus;
+    /**
+     * The date and time in GMT when the Engagement was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the Engagement was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateUpdated: Date;
+    /**
+     * The absolute URL of the resource.
+     */
+    url: string;
+    /**
+     * The URLs of the Engagement\'s nested resources.
+     */
+    links: Record<string, string>;
+    private get _proxy();
+    /**
+     * Remove a EngagementInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a EngagementInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed EngagementInstance
+     */
+    fetch(callback?: (error: Error | null, item?: EngagementInstance) => any): Promise<EngagementInstance>;
+    /**
+     * Access the engagementContext.
+     */
+    engagementContext(): EngagementContextListInstance;
+    /**
+     * Access the steps.
+     */
+    steps(): StepListInstance;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        sid: string;
+        accountSid: string;
+        flowSid: string;
+        contactSid: string;
+        contactChannelAddress: string;
+        context: any;
+        status: EngagementStatus;
+        dateCreated: Date;
+        dateUpdated: Date;
+        url: string;
+        links: Record<string, string>;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface EngagementSolution {
+    flowSid: string;
+}
+export interface EngagementListInstance {
+    _version: V1;
+    _solution: EngagementSolution;
+    _uri: string;
+    (sid: string): EngagementContext;
+    get(sid: string): EngagementContext;
+    /**
+     * Create a EngagementInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed EngagementInstance
+     */
+    create(params: EngagementListInstanceCreateOptions, callback?: (error: Error | null, item?: EngagementInstance) => any): Promise<EngagementInstance>;
+    /**
+     * Streams EngagementInstance 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 { EngagementListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: EngagementInstance, done: (err?: Error) => void) => void): void;
+    each(params: EngagementListInstanceEachOptions, callback?: (item: EngagementInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of EngagementInstance 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: EngagementPage) => any): Promise<EngagementPage>;
+    /**
+     * Lists EngagementInstance 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 { EngagementListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: EngagementInstance[]) => any): Promise<EngagementInstance[]>;
+    list(params: EngagementListInstanceOptions, callback?: (error: Error | null, items: EngagementInstance[]) => any): Promise<EngagementInstance[]>;
+    /**
+     * Retrieve a single page of EngagementInstance 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 { EngagementListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: EngagementPage) => any): Promise<EngagementPage>;
+    page(params: EngagementListInstancePageOptions, callback?: (error: Error | null, items: EngagementPage) => any): Promise<EngagementPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function EngagementListInstance(version: V1, flowSid: string): EngagementListInstance;
+export declare class EngagementPage extends Page<V1, EngagementPayload, EngagementResource, EngagementInstance> {
+    /**
+     * Initialize the EngagementPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: EngagementSolution);
+    /**
+     * Build an instance of EngagementInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: EngagementResource): EngagementInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/studio/v1/flow/engagement.js

@@ -0,0 +1,269 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Studio
+ * 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.EngagementPage = exports.EngagementListInstance = exports.EngagementInstance = exports.EngagementContextImpl = 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");
+const engagementContext_1 = require("./engagement/engagementContext");
+const step_1 = require("./engagement/step");
+class EngagementContextImpl {
+    constructor(_version, flowSid, sid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(flowSid)) {
+            throw new Error("Parameter 'flowSid' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(sid)) {
+            throw new Error("Parameter 'sid' is not valid.");
+        }
+        this._solution = { flowSid, sid };
+        this._uri = `/Flows/${flowSid}/Engagements/${sid}`;
+    }
+    get engagementContext() {
+        this._engagementContext =
+            this._engagementContext ||
+                (0, engagementContext_1.EngagementContextListInstance)(this._version, this._solution.flowSid, this._solution.sid);
+        return this._engagementContext;
+    }
+    get steps() {
+        this._steps =
+            this._steps ||
+                (0, step_1.StepListInstance)(this._version, this._solution.flowSid, this._solution.sid);
+        return this._steps;
+    }
+    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 EngagementInstance(operationVersion, payload, instance._solution.flowSid, 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.EngagementContextImpl = EngagementContextImpl;
+class EngagementInstance {
+    constructor(_version, payload, flowSid, sid) {
+        this._version = _version;
+        this.sid = payload.sid;
+        this.accountSid = payload.account_sid;
+        this.flowSid = payload.flow_sid;
+        this.contactSid = payload.contact_sid;
+        this.contactChannelAddress = payload.contact_channel_address;
+        this.context = payload.context;
+        this.status = payload.status;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this.url = payload.url;
+        this.links = payload.links;
+        this._solution = { flowSid, sid: sid || this.sid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new EngagementContextImpl(this._version, this._solution.flowSid, this._solution.sid);
+        return this._context;
+    }
+    /**
+     * Remove a EngagementInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a EngagementInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed EngagementInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Access the engagementContext.
+     */
+    engagementContext() {
+        return this._proxy.engagementContext;
+    }
+    /**
+     * Access the steps.
+     */
+    steps() {
+        return this._proxy.steps;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            sid: this.sid,
+            accountSid: this.accountSid,
+            flowSid: this.flowSid,
+            contactSid: this.contactSid,
+            contactChannelAddress: this.contactChannelAddress,
+            context: this.context,
+            status: this.status,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+            url: this.url,
+            links: this.links,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.EngagementInstance = EngagementInstance;
+function EngagementListInstance(version, flowSid) {
+    if (!(0, utility_1.isValidPathParam)(flowSid)) {
+        throw new Error("Parameter 'flowSid' is not valid.");
+    }
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new EngagementContextImpl(version, flowSid, sid);
+    };
+    instance._version = version;
+    instance._solution = { flowSid };
+    instance._uri = `/Flows/${flowSid}/Engagements`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["to"] === null || params["to"] === undefined) {
+            throw new Error("Required parameter \"params['to']\" missing.");
+        }
+        if (params["from"] === null || params["from"] === undefined) {
+            throw new Error("Required parameter \"params['from']\" missing.");
+        }
+        let data = {};
+        data["To"] = params["to"];
+        data["From"] = params["from"];
+        if (params["parameters"] !== undefined)
+            data["Parameters"] = serialize.object(params["parameters"]);
+        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 EngagementInstance(operationVersion, payload, instance._solution.flowSid));
+        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 EngagementPage(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 EngagementPage(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.EngagementListInstance = EngagementListInstance;
+class EngagementPage extends Page_1.default {
+    /**
+     * Initialize the EngagementPage
+     *
+     * @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 EngagementInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new EngagementInstance(this._version, payload, this._solution.flowSid);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.EngagementPage = EngagementPage;

package/lib/rest/studio/v1/flow/execution/executionContext.d.ts

@@ -0,0 +1,109 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V1 from "../../../V1";
+export interface ExecutionContextContext {
+    /**
+     * Fetch a ExecutionContextInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ExecutionContextInstance
+     */
+    fetch(callback?: (error: Error | null, item?: ExecutionContextInstance) => any): Promise<ExecutionContextInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface ExecutionContextContextSolution {
+    flowSid: string;
+    executionSid: string;
+}
+export declare class ExecutionContextContextImpl implements ExecutionContextContext {
+    protected _version: V1;
+    protected _solution: ExecutionContextContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, flowSid: string, executionSid: string);
+    fetch(callback?: (error: Error | null, item?: ExecutionContextInstance) => any): Promise<ExecutionContextInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): ExecutionContextContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface ExecutionContextResource {
+    account_sid: string;
+    context: any;
+    flow_sid: string;
+    execution_sid: string;
+    url: string;
+}
+export declare class ExecutionContextInstance {
+    protected _version: V1;
+    protected _solution: ExecutionContextContextSolution;
+    protected _context?: ExecutionContextContext;
+    constructor(_version: V1, payload: ExecutionContextResource, flowSid: string, executionSid: string);
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ExecutionContext resource.
+     */
+    accountSid: string;
+    /**
+     * The current state of the Flow\'s Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.
+     */
+    context: any;
+    /**
+     * The SID of the Flow.
+     */
+    flowSid: string;
+    /**
+     * The SID of the context\'s Execution resource.
+     */
+    executionSid: string;
+    /**
+     * The absolute URL of the resource.
+     */
+    url: string;
+    private get _proxy();
+    /**
+     * Fetch a ExecutionContextInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ExecutionContextInstance
+     */
+    fetch(callback?: (error: Error | null, item?: ExecutionContextInstance) => any): Promise<ExecutionContextInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        context: any;
+        flowSid: string;
+        executionSid: string;
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface ExecutionContextSolution {
+    flowSid: string;
+    executionSid: string;
+}
+export interface ExecutionContextListInstance {
+    _version: V1;
+    _solution: ExecutionContextSolution;
+    _uri: string;
+    (): ExecutionContextContext;
+    get(): ExecutionContextContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function ExecutionContextListInstance(version: V1, flowSid: string, executionSid: string): ExecutionContextListInstance;
+export {};