twilio 4.7.1 → 4.7.2

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

@@ -0,0 +1,357 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V1 from "../V1";
+/**
+ * Options to pass to remove a InsightsQuestionnairesInstance
+ */
+export interface InsightsQuestionnairesContextRemoveOptions {
+    /** The Token HTTP request header */
+    token?: string;
+}
+/**
+ * Options to pass to fetch a InsightsQuestionnairesInstance
+ */
+export interface InsightsQuestionnairesContextFetchOptions {
+    /** The Token HTTP request header */
+    token?: string;
+}
+/**
+ * Options to pass to update a InsightsQuestionnairesInstance
+ */
+export interface InsightsQuestionnairesContextUpdateOptions {
+    /** The flag to enable or disable questionnaire */
+    active: boolean;
+    /** The Token HTTP request header */
+    token?: string;
+    /** The name of this questionnaire */
+    name?: string;
+    /** The description of this questionnaire */
+    description?: string;
+    /** The list of questions ids under a questionnaire */
+    questionIds?: Array<string>;
+}
+/**
+ * Options to pass to create a InsightsQuestionnairesInstance
+ */
+export interface InsightsQuestionnairesListInstanceCreateOptions {
+    /** The name of this questionnaire */
+    name: string;
+    /** The Token HTTP request header */
+    token?: string;
+    /** The description of this questionnaire */
+    description?: string;
+    /** The flag to enable or disable questionnaire */
+    active?: boolean;
+    /** The list of questions ids under a questionnaire */
+    questionIds?: Array<string>;
+}
+/**
+ * Options to pass to each
+ */
+export interface InsightsQuestionnairesListInstanceEachOptions {
+    /** The Token HTTP request header */
+    token?: string;
+    /** Flag indicating whether to include inactive questionnaires or not */
+    includeInactive?: boolean;
+    /** 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: InsightsQuestionnairesInstance, 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 InsightsQuestionnairesListInstanceOptions {
+    /** The Token HTTP request header */
+    token?: string;
+    /** Flag indicating whether to include inactive questionnaires or not */
+    includeInactive?: boolean;
+    /** 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 InsightsQuestionnairesListInstancePageOptions {
+    /** The Token HTTP request header */
+    token?: string;
+    /** Flag indicating whether to include inactive questionnaires or not */
+    includeInactive?: boolean;
+    /** 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 InsightsQuestionnairesContext {
+    /**
+     * Remove a InsightsQuestionnairesInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Remove a InsightsQuestionnairesInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    remove(params: InsightsQuestionnairesContextRemoveOptions, callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a InsightsQuestionnairesInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    fetch(callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    /**
+     * Fetch a InsightsQuestionnairesInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    fetch(params: InsightsQuestionnairesContextFetchOptions, callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    /**
+     * Update a InsightsQuestionnairesInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    update(params: InsightsQuestionnairesContextUpdateOptions, callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface InsightsQuestionnairesContextSolution {
+    id: string;
+}
+export declare class InsightsQuestionnairesContextImpl implements InsightsQuestionnairesContext {
+    protected _version: V1;
+    protected _solution: InsightsQuestionnairesContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, id: string);
+    remove(params?: InsightsQuestionnairesContextRemoveOptions | ((error: Error | null, item?: boolean) => any), callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(params?: InsightsQuestionnairesContextFetchOptions | ((error: Error | null, item?: InsightsQuestionnairesInstance) => any), callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    update(params: InsightsQuestionnairesContextUpdateOptions, callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): InsightsQuestionnairesContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface InsightsQuestionnairesPayload extends TwilioResponsePayload {
+    questionnaires: InsightsQuestionnairesResource[];
+}
+interface InsightsQuestionnairesResource {
+    account_sid: string;
+    id: string;
+    name: string;
+    description: string;
+    active: boolean;
+    questions: Array<any>;
+    url: string;
+}
+export declare class InsightsQuestionnairesInstance {
+    protected _version: V1;
+    protected _solution: InsightsQuestionnairesContextSolution;
+    protected _context?: InsightsQuestionnairesContext;
+    constructor(_version: V1, payload: InsightsQuestionnairesResource, id?: string);
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource.
+     */
+    accountSid: string;
+    /**
+     * The unique id of this questionnaire
+     */
+    id: string;
+    /**
+     * The name of this category.
+     */
+    name: string;
+    /**
+     * The description of this questionnaire
+     */
+    description: string;
+    /**
+     * The flag to enable or disable questionnaire
+     */
+    active: boolean;
+    /**
+     * The list of questions with category for a questionnaire
+     */
+    questions: Array<any>;
+    url: string;
+    private get _proxy();
+    /**
+     * Remove a InsightsQuestionnairesInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Remove a InsightsQuestionnairesInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    remove(params: InsightsQuestionnairesContextRemoveOptions, callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a InsightsQuestionnairesInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    fetch(callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    /**
+     * Fetch a InsightsQuestionnairesInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    fetch(params: InsightsQuestionnairesContextFetchOptions, callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    /**
+     * Update a InsightsQuestionnairesInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    update(params: InsightsQuestionnairesContextUpdateOptions, callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        id: string;
+        name: string;
+        description: string;
+        active: boolean;
+        questions: any[];
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface InsightsQuestionnairesSolution {
+}
+export interface InsightsQuestionnairesListInstance {
+    _version: V1;
+    _solution: InsightsQuestionnairesSolution;
+    _uri: string;
+    (id: string): InsightsQuestionnairesContext;
+    get(id: string): InsightsQuestionnairesContext;
+    /**
+     * Create a InsightsQuestionnairesInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InsightsQuestionnairesInstance
+     */
+    create(params: InsightsQuestionnairesListInstanceCreateOptions, callback?: (error: Error | null, item?: InsightsQuestionnairesInstance) => any): Promise<InsightsQuestionnairesInstance>;
+    /**
+     * Streams InsightsQuestionnairesInstance 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 { InsightsQuestionnairesListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: InsightsQuestionnairesInstance, done: (err?: Error) => void) => void): void;
+    each(params: InsightsQuestionnairesListInstanceEachOptions, callback?: (item: InsightsQuestionnairesInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of InsightsQuestionnairesInstance 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: InsightsQuestionnairesPage) => any): Promise<InsightsQuestionnairesPage>;
+    /**
+     * Lists InsightsQuestionnairesInstance 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 { InsightsQuestionnairesListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: InsightsQuestionnairesInstance[]) => any): Promise<InsightsQuestionnairesInstance[]>;
+    list(params: InsightsQuestionnairesListInstanceOptions, callback?: (error: Error | null, items: InsightsQuestionnairesInstance[]) => any): Promise<InsightsQuestionnairesInstance[]>;
+    /**
+     * Retrieve a single page of InsightsQuestionnairesInstance 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 { InsightsQuestionnairesListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: InsightsQuestionnairesPage) => any): Promise<InsightsQuestionnairesPage>;
+    page(params: InsightsQuestionnairesListInstancePageOptions, callback?: (error: Error | null, items: InsightsQuestionnairesPage) => any): Promise<InsightsQuestionnairesPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function InsightsQuestionnairesListInstance(version: V1): InsightsQuestionnairesListInstance;
+export declare class InsightsQuestionnairesPage extends Page<V1, InsightsQuestionnairesPayload, InsightsQuestionnairesResource, InsightsQuestionnairesInstance> {
+    /**
+     * Initialize the InsightsQuestionnairesPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: InsightsQuestionnairesSolution);
+    /**
+     * Build an instance of InsightsQuestionnairesInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: InsightsQuestionnairesResource): InsightsQuestionnairesInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,280 @@
+"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.InsightsQuestionnairesPage = exports.InsightsQuestionnairesListInstance = exports.InsightsQuestionnairesInstance = exports.InsightsQuestionnairesContextImpl = 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 InsightsQuestionnairesContextImpl {
+    constructor(_version, id) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(id)) {
+            throw new Error("Parameter 'id' is not valid.");
+        }
+        this._solution = { id };
+        this._uri = `/Insights/QM/Questionnaires/${id}`;
+    }
+    remove(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        const headers = {};
+        if (params["token"] !== undefined)
+            headers["Token"] = params["token"];
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.remove({
+            uri: instance._uri,
+            method: "delete",
+            params: data,
+            headers,
+        });
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    fetch(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        const headers = {};
+        if (params["token"] !== undefined)
+            headers["Token"] = params["token"];
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new InsightsQuestionnairesInstance(operationVersion, payload, instance._solution.id));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    update(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["active"] === null || params["active"] === undefined) {
+            throw new Error("Required parameter \"params['active']\" missing.");
+        }
+        let data = {};
+        data["Active"] = serialize.bool(params["active"]);
+        if (params["name"] !== undefined)
+            data["Name"] = params["name"];
+        if (params["description"] !== undefined)
+            data["Description"] = params["description"];
+        if (params["questionIds"] !== undefined)
+            data["QuestionIds"] = serialize.map(params["questionIds"], (e) => e);
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        if (params["token"] !== undefined)
+            headers["Token"] = params["token"];
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new InsightsQuestionnairesInstance(operationVersion, payload, instance._solution.id));
+        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.InsightsQuestionnairesContextImpl = InsightsQuestionnairesContextImpl;
+class InsightsQuestionnairesInstance {
+    constructor(_version, payload, id) {
+        this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.id = payload.id;
+        this.name = payload.name;
+        this.description = payload.description;
+        this.active = payload.active;
+        this.questions = payload.questions;
+        this.url = payload.url;
+        this._solution = { id: id || this.id };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new InsightsQuestionnairesContextImpl(this._version, this._solution.id);
+        return this._context;
+    }
+    remove(params, callback) {
+        return this._proxy.remove(params, callback);
+    }
+    fetch(params, callback) {
+        return this._proxy.fetch(params, callback);
+    }
+    update(params, callback) {
+        return this._proxy.update(params, callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accountSid: this.accountSid,
+            id: this.id,
+            name: this.name,
+            description: this.description,
+            active: this.active,
+            questions: this.questions,
+            url: this.url,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.InsightsQuestionnairesInstance = InsightsQuestionnairesInstance;
+function InsightsQuestionnairesListInstance(version) {
+    const instance = ((id) => instance.get(id));
+    instance.get = function get(id) {
+        return new InsightsQuestionnairesContextImpl(version, id);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Insights/QM/Questionnaires`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["name"] === null || params["name"] === undefined) {
+            throw new Error("Required parameter \"params['name']\" missing.");
+        }
+        let data = {};
+        data["Name"] = params["name"];
+        if (params["description"] !== undefined)
+            data["Description"] = params["description"];
+        if (params["active"] !== undefined)
+            data["Active"] = serialize.bool(params["active"]);
+        if (params["questionIds"] !== undefined)
+            data["QuestionIds"] = serialize.map(params["questionIds"], (e) => e);
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        if (params["token"] !== undefined)
+            headers["Token"] = params["token"];
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new InsightsQuestionnairesInstance(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["includeInactive"] !== undefined)
+            data["IncludeInactive"] = serialize.bool(params["includeInactive"]);
+        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 = {};
+        if (params["token"] !== undefined)
+            headers["Token"] = params["token"];
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new InsightsQuestionnairesPage(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 InsightsQuestionnairesPage(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.InsightsQuestionnairesListInstance = InsightsQuestionnairesListInstance;
+class InsightsQuestionnairesPage extends Page_1.default {
+    /**
+     * Initialize the InsightsQuestionnairesPage
+     *
+     * @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 InsightsQuestionnairesInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new InsightsQuestionnairesInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.InsightsQuestionnairesPage = InsightsQuestionnairesPage;