twilio 4.7.2 → 4.9.0

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

@@ -1,15 +1,107 @@
 /// <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 update a AssessmentsInstance
+ */
+export interface AssessmentsContextUpdateOptions {
+    /** The offset of the conversation */
+    offset: number;
+    /** The answer text selected by user */
+    answerText: string;
+    /** The id of the answer selected by user */
+    answerId: string;
+    /** The Token HTTP request header */
+    token?: string;
+}
+/**
+ * Options to pass to create a AssessmentsInstance
+ */
+export interface AssessmentsListInstanceCreateOptions {
+    /** The id of the category  */
+    categoryId: string;
+    /** The name of the category */
+    categoryName: string;
+    /** Segment Id of the conversation */
+    segmentId: string;
+    /** Name of the user assessing conversation */
+    userName: string;
+    /** Email of the user assessing conversation */
+    userEmail: string;
+    /** The id of the Agent */
+    agentId: string;
+    /** The offset of the conversation. */
+    offset: number;
+    /** The question Id selected for assessment */
+    metricId: string;
+    /** The question name of the assessment */
+    metricName: string;
+    /** The answer text selected by user */
+    answerText: string;
+    /** The id of the answer selected by user */
+    answerId: string;
+    /** Questionnaire Id of the associated question */
+    questionnaireId: string;
+    /** The Token HTTP request header */
+    token?: string;
+}
+/**
+ * Options to pass to each
+ */
+export interface AssessmentsListInstanceEachOptions {
+    /** The Token HTTP request header */
+    token?: string;
+    /** The id of the segment. */
+    segmentId?: 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: AssessmentsInstance, 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 AssessmentsListInstanceOptions {
+    /** The Token HTTP request header */
+    token?: string;
+    /** The id of the segment. */
+    segmentId?: 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 AssessmentsListInstancePageOptions {
+    /** The Token HTTP request header */
+    token?: string;
+    /** The id of the segment. */
+    segmentId?: 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 AssessmentsContext {
     /**
-     * Create a AssessmentsInstance
+     * Update a AssessmentsInstance
      *
+     * @param params - Parameter for request
      * @param callback - Callback to handle processed record
      *
      * @returns Resolves to processed AssessmentsInstance
      */
-    create(callback?: (error: Error | null, item?: AssessmentsInstance) => any): Promise<AssessmentsInstance>;
+    update(params: AssessmentsContextUpdateOptions, callback?: (error: Error | null, item?: AssessmentsInstance) => any): Promise<AssessmentsInstance>;
     /**
      * Provide a user-friendly representation
      */
@@ -17,13 +109,14 @@ export interface AssessmentsContext {
     [inspect.custom](_depth: any, options: InspectOptions): any;
 }
 export interface AssessmentsContextSolution {
+    assessmentId: string;
 }
 export declare class AssessmentsContextImpl implements AssessmentsContext {
     protected _version: V1;
     protected _solution: AssessmentsContextSolution;
     protected _uri: string;
-    constructor(_version: V1);
-    create(callback?: (error: Error | null, item?: AssessmentsInstance) => any): Promise<AssessmentsInstance>;
+    constructor(_version: V1, assessmentId: string);
+    update(params: AssessmentsContextUpdateOptions, callback?: (error: Error | null, item?: AssessmentsInstance) => any): Promise<AssessmentsInstance>;
     /**
      * Provide a user-friendly representation
      *
@@ -32,33 +125,109 @@ export declare class AssessmentsContextImpl implements AssessmentsContext {
     toJSON(): AssessmentsContextSolution;
     [inspect.custom](_depth: any, options: InspectOptions): string;
 }
+interface AssessmentsPayload extends TwilioResponsePayload {
+    assessments: AssessmentsResource[];
+}
 interface AssessmentsResource {
+    account_sid: string;
+    assessment_id: string;
+    offset: number;
+    report: boolean;
+    weight: number;
+    agent_id: string;
+    segment_id: string;
+    user_name: string;
+    user_email: string;
+    answer_text: string;
+    answer_id: string;
+    assessment: any;
+    timestamp: number;
     url: string;
 }
 export declare class AssessmentsInstance {
     protected _version: V1;
     protected _solution: AssessmentsContextSolution;
     protected _context?: AssessmentsContext;
-    constructor(_version: V1, payload: AssessmentsResource);
+    constructor(_version: V1, payload: AssessmentsResource, assessmentId?: string);
+    /**
+     * The unique SID identifier of the Account.
+     */
+    accountSid: string;
+    /**
+     * The unique id of the assessment
+     */
+    assessmentId: string;
+    /**
+     * Offset of the conversation
+     */
+    offset: number;
+    /**
+     * The flag indicating if this assessment is part of report
+     */
+    report: boolean;
+    /**
+     * The weightage given to this comment
+     */
+    weight: number;
+    /**
+     * The id of the Agent
+     */
+    agentId: string;
+    /**
+     * Segment Id of conversation
+     */
+    segmentId: string;
+    /**
+     * The name of the user.
+     */
+    userName: string;
+    /**
+     * The email id of the user.
+     */
+    userEmail: string;
+    /**
+     * The answer text selected by user
+     */
+    answerText: string;
+    /**
+     * The id of the answer selected by user
+     */
+    answerId: string;
     /**
-     * The URL of this resource.
+     * Assessment Details associated with an assessment
      */
+    assessment: any;
+    timestamp: number;
     url: string;
     private get _proxy();
     /**
-     * Create a AssessmentsInstance
+     * Update a AssessmentsInstance
      *
+     * @param params - Parameter for request
      * @param callback - Callback to handle processed record
      *
      * @returns Resolves to processed AssessmentsInstance
      */
-    create(callback?: (error: Error | null, item?: AssessmentsInstance) => any): Promise<AssessmentsInstance>;
+    update(params: AssessmentsContextUpdateOptions, callback?: (error: Error | null, item?: AssessmentsInstance) => any): Promise<AssessmentsInstance>;
     /**
      * Provide a user-friendly representation
      *
      * @returns Object
      */
     toJSON(): {
+        accountSid: string;
+        assessmentId: string;
+        offset: number;
+        report: boolean;
+        weight: number;
+        agentId: string;
+        segmentId: string;
+        userName: string;
+        userEmail: string;
+        answerText: string;
+        answerId: string;
+        assessment: any;
+        timestamp: number;
         url: string;
     };
     [inspect.custom](_depth: any, options: InspectOptions): string;
@@ -69,8 +238,67 @@ export interface AssessmentsListInstance {
     _version: V1;
     _solution: AssessmentsSolution;
     _uri: string;
-    (): AssessmentsContext;
-    get(): AssessmentsContext;
+    (assessmentId: string): AssessmentsContext;
+    get(assessmentId: string): AssessmentsContext;
+    /**
+     * Create a AssessmentsInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AssessmentsInstance
+     */
+    create(params: AssessmentsListInstanceCreateOptions, callback?: (error: Error | null, item?: AssessmentsInstance) => any): Promise<AssessmentsInstance>;
+    /**
+     * Streams AssessmentsInstance 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 { AssessmentsListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: AssessmentsInstance, done: (err?: Error) => void) => void): void;
+    each(params: AssessmentsListInstanceEachOptions, callback?: (item: AssessmentsInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of AssessmentsInstance 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: AssessmentsPage) => any): Promise<AssessmentsPage>;
+    /**
+     * Lists AssessmentsInstance 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 { AssessmentsListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: AssessmentsInstance[]) => any): Promise<AssessmentsInstance[]>;
+    list(params: AssessmentsListInstanceOptions, callback?: (error: Error | null, items: AssessmentsInstance[]) => any): Promise<AssessmentsInstance[]>;
+    /**
+     * Retrieve a single page of AssessmentsInstance 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 { AssessmentsListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: AssessmentsPage) => any): Promise<AssessmentsPage>;
+    page(params: AssessmentsListInstancePageOptions, callback?: (error: Error | null, items: AssessmentsPage) => any): Promise<AssessmentsPage>;
     /**
      * Provide a user-friendly representation
      */
@@ -78,4 +306,21 @@ export interface AssessmentsListInstance {
     [inspect.custom](_depth: any, options: InspectOptions): any;
 }
 export declare function AssessmentsListInstance(version: V1): AssessmentsListInstance;
+export declare class AssessmentsPage extends Page<V1, AssessmentsPayload, AssessmentsResource, AssessmentsInstance> {
+    /**
+     * Initialize the AssessmentsPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: AssessmentsSolution);
+    /**
+     * Build an instance of AssessmentsInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: AssessmentsResource): AssessmentsInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
 export {};

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

@@ -12,24 +12,54 @@
  * 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.AssessmentsListInstance = exports.AssessmentsInstance = exports.AssessmentsContextImpl = void 0;
+exports.AssessmentsPage = exports.AssessmentsListInstance = exports.AssessmentsInstance = exports.AssessmentsContextImpl = 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 AssessmentsContextImpl {
-    constructor(_version) {
+    constructor(_version, assessmentId) {
         this._version = _version;
-        this._solution = {};
-        this._uri = `/Accounts/Assessments`;
+        if (!(0, utility_1.isValidPathParam)(assessmentId)) {
+            throw new Error("Parameter 'assessmentId' is not valid.");
+        }
+        this._solution = { assessmentId };
+        this._uri = `/Insights/QM/Assessments/${assessmentId}`;
     }
-    create(callback) {
+    update(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["offset"] === null || params["offset"] === undefined) {
+            throw new Error("Required parameter \"params['offset']\" missing.");
+        }
+        if (params["answerText"] === null || params["answerText"] === undefined) {
+            throw new Error("Required parameter \"params['answerText']\" missing.");
+        }
+        if (params["answerId"] === null || params["answerId"] === undefined) {
+            throw new Error("Required parameter \"params['answerId']\" missing.");
+        }
+        let data = {};
+        data["Offset"] = params["offset"];
+        data["AnswerText"] = params["answerText"];
+        data["AnswerId"] = params["answerId"];
+        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.create({
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
             uri: instance._uri,
             method: "post",
+            data,
+            headers,
         });
-        operationPromise = operationPromise.then((payload) => new AssessmentsInstance(operationVersion, payload));
+        operationPromise = operationPromise.then((payload) => new AssessmentsInstance(operationVersion, payload, instance._solution.assessmentId));
         operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
         return operationPromise;
     }
@@ -47,24 +77,32 @@ class AssessmentsContextImpl {
 }
 exports.AssessmentsContextImpl = AssessmentsContextImpl;
 class AssessmentsInstance {
-    constructor(_version, payload) {
+    constructor(_version, payload, assessmentId) {
         this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.assessmentId = payload.assessment_id;
+        this.offset = payload.offset;
+        this.report = payload.report;
+        this.weight = payload.weight;
+        this.agentId = payload.agent_id;
+        this.segmentId = payload.segment_id;
+        this.userName = payload.user_name;
+        this.userEmail = payload.user_email;
+        this.answerText = payload.answer_text;
+        this.answerId = payload.answer_id;
+        this.assessment = payload.assessment;
+        this.timestamp = payload.timestamp;
         this.url = payload.url;
-        this._solution = {};
+        this._solution = { assessmentId: assessmentId || this.assessmentId };
     }
     get _proxy() {
-        this._context = this._context || new AssessmentsContextImpl(this._version);
+        this._context =
+            this._context ||
+                new AssessmentsContextImpl(this._version, this._solution.assessmentId);
         return this._context;
     }
-    /**
-     * Create a AssessmentsInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed AssessmentsInstance
-     */
-    create(callback) {
-        return this._proxy.create(callback);
+    update(params, callback) {
+        return this._proxy.update(params, callback);
     }
     /**
      * Provide a user-friendly representation
@@ -73,6 +111,19 @@ class AssessmentsInstance {
      */
     toJSON() {
         return {
+            accountSid: this.accountSid,
+            assessmentId: this.assessmentId,
+            offset: this.offset,
+            report: this.report,
+            weight: this.weight,
+            agentId: this.agentId,
+            segmentId: this.segmentId,
+            userName: this.userName,
+            userEmail: this.userEmail,
+            answerText: this.answerText,
+            answerId: this.answerId,
+            assessment: this.assessment,
+            timestamp: this.timestamp,
             url: this.url,
         };
     }
@@ -82,13 +133,123 @@ class AssessmentsInstance {
 }
 exports.AssessmentsInstance = AssessmentsInstance;
 function AssessmentsListInstance(version) {
-    const instance = (() => instance.get());
-    instance.get = function get() {
-        return new AssessmentsContextImpl(version);
+    const instance = ((assessmentId) => instance.get(assessmentId));
+    instance.get = function get(assessmentId) {
+        return new AssessmentsContextImpl(version, assessmentId);
     };
     instance._version = version;
     instance._solution = {};
-    instance._uri = ``;
+    instance._uri = `/Insights/QM/Assessments`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["categoryId"] === null || params["categoryId"] === undefined) {
+            throw new Error("Required parameter \"params['categoryId']\" missing.");
+        }
+        if (params["categoryName"] === null ||
+            params["categoryName"] === undefined) {
+            throw new Error("Required parameter \"params['categoryName']\" missing.");
+        }
+        if (params["segmentId"] === null || params["segmentId"] === undefined) {
+            throw new Error("Required parameter \"params['segmentId']\" missing.");
+        }
+        if (params["userName"] === null || params["userName"] === undefined) {
+            throw new Error("Required parameter \"params['userName']\" missing.");
+        }
+        if (params["userEmail"] === null || params["userEmail"] === undefined) {
+            throw new Error("Required parameter \"params['userEmail']\" missing.");
+        }
+        if (params["agentId"] === null || params["agentId"] === undefined) {
+            throw new Error("Required parameter \"params['agentId']\" missing.");
+        }
+        if (params["offset"] === null || params["offset"] === undefined) {
+            throw new Error("Required parameter \"params['offset']\" missing.");
+        }
+        if (params["metricId"] === null || params["metricId"] === undefined) {
+            throw new Error("Required parameter \"params['metricId']\" missing.");
+        }
+        if (params["metricName"] === null || params["metricName"] === undefined) {
+            throw new Error("Required parameter \"params['metricName']\" missing.");
+        }
+        if (params["answerText"] === null || params["answerText"] === undefined) {
+            throw new Error("Required parameter \"params['answerText']\" missing.");
+        }
+        if (params["answerId"] === null || params["answerId"] === undefined) {
+            throw new Error("Required parameter \"params['answerId']\" missing.");
+        }
+        if (params["questionnaireId"] === null ||
+            params["questionnaireId"] === undefined) {
+            throw new Error("Required parameter \"params['questionnaireId']\" missing.");
+        }
+        let data = {};
+        data["CategoryId"] = params["categoryId"];
+        data["CategoryName"] = params["categoryName"];
+        data["SegmentId"] = params["segmentId"];
+        data["UserName"] = params["userName"];
+        data["UserEmail"] = params["userEmail"];
+        data["AgentId"] = params["agentId"];
+        data["Offset"] = params["offset"];
+        data["MetricId"] = params["metricId"];
+        data["MetricName"] = params["metricName"];
+        data["AnswerText"] = params["answerText"];
+        data["AnswerId"] = params["answerId"];
+        data["QuestionnaireId"] = params["questionnaireId"];
+        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 AssessmentsInstance(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["segmentId"] !== undefined)
+            data["SegmentId"] = params["segmentId"];
+        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 AssessmentsPage(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 AssessmentsPage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
     instance.toJSON = function toJSON() {
         return instance._solution;
     };
@@ -98,3 +259,27 @@ function AssessmentsListInstance(version) {
     return instance;
 }
 exports.AssessmentsListInstance = AssessmentsListInstance;
+class AssessmentsPage extends Page_1.default {
+    /**
+     * Initialize the AssessmentsPage
+     *
+     * @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 AssessmentsInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new AssessmentsInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AssessmentsPage = AssessmentsPage;

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

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { inspect, InspectOptions } from "util";
 import V1 from "../V1";
-type ConfigurationStatus = "ok" | "inprogress" | "notstarted";
+export type ConfigurationStatus = "ok" | "inprogress" | "notstarted";
 /**
  * Options to pass to fetch a ConfigurationInstance
  */

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

@@ -3,8 +3,8 @@ import { inspect, InspectOptions } from "util";
 import Page, { TwilioResponsePayload } from "../../../base/Page";
 import Response from "../../../http/response";
 import V1 from "../V1";
-type FlexFlowChannelType = "web" | "sms" | "facebook" | "whatsapp" | "line" | "custom";
-type FlexFlowIntegrationType = "studio" | "external" | "task";
+export type FlexFlowChannelType = "web" | "sms" | "facebook" | "whatsapp" | "line" | "custom";
+export type FlexFlowIntegrationType = "studio" | "external" | "task";
 /**
  * Options to pass to update a FlexFlowInstance
  */