twilio 5.3.0 → 5.3.2

package/lib/rest/assistants/v1/assistant/feedback.d.ts

@@ -0,0 +1,231 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import V1 from "../../V1";
+export declare class AssistantsV1ServiceCreateFeedbackRequest {
+    /**
+     * The message ID.
+     */
+    "messageId"?: string;
+    /**
+     * The score to be given(0-1).
+     */
+    "score"?: number;
+    /**
+     * The Session ID.
+     */
+    "sessionId": string;
+    /**
+     * The text to be given as feedback.
+     */
+    "text"?: string;
+}
+/**
+ * Options to pass to create a FeedbackInstance
+ */
+export interface FeedbackListInstanceCreateOptions {
+    /**  */
+    assistantsV1ServiceCreateFeedbackRequest: AssistantsV1ServiceCreateFeedbackRequest;
+}
+/**
+ * Options to pass to each
+ */
+export interface FeedbackListInstanceEachOptions {
+    /** 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: FeedbackInstance, 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 FeedbackListInstanceOptions {
+    /** 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 FeedbackListInstancePageOptions {
+    /** 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 FeedbackSolution {
+    id: string;
+}
+export interface FeedbackListInstance {
+    _version: V1;
+    _solution: FeedbackSolution;
+    _uri: string;
+    /**
+     * Create a FeedbackInstance
+     *
+     * @param params - Body for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed FeedbackInstance
+     */
+    create(params: AssistantsV1ServiceCreateFeedbackRequest, callback?: (error: Error | null, item?: FeedbackInstance) => any): Promise<FeedbackInstance>;
+    /**
+     * Streams FeedbackInstance 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 { FeedbackListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: FeedbackInstance, done: (err?: Error) => void) => void): void;
+    each(params: FeedbackListInstanceEachOptions, callback?: (item: FeedbackInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of FeedbackInstance 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: FeedbackPage) => any): Promise<FeedbackPage>;
+    /**
+     * Lists FeedbackInstance 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 { FeedbackListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: FeedbackInstance[]) => any): Promise<FeedbackInstance[]>;
+    list(params: FeedbackListInstanceOptions, callback?: (error: Error | null, items: FeedbackInstance[]) => any): Promise<FeedbackInstance[]>;
+    /**
+     * Retrieve a single page of FeedbackInstance 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 { FeedbackListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: FeedbackPage) => any): Promise<FeedbackPage>;
+    page(params: FeedbackListInstancePageOptions, callback?: (error: Error | null, items: FeedbackPage) => any): Promise<FeedbackPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function FeedbackListInstance(version: V1, id: string): FeedbackListInstance;
+interface FeedbackPayload extends TwilioResponsePayload {
+    feedbacks: FeedbackResource[];
+}
+interface FeedbackResource {
+    assistant_id: string;
+    id: string;
+    account_sid: string;
+    user_sid: string;
+    message_id: string;
+    score: number;
+    session_id: string;
+    text: string;
+    date_created: Date;
+    date_updated: Date;
+}
+export declare class FeedbackInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: FeedbackResource, id: string);
+    /**
+     * The Assistant ID.
+     */
+    assistantId: string;
+    /**
+     * The Feedback ID.
+     */
+    id: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Feedback.
+     */
+    accountSid: string;
+    /**
+     * The SID of the User created the Feedback.
+     */
+    userSid: string;
+    /**
+     * The Message ID.
+     */
+    messageId: string;
+    /**
+     * The Score to provide as Feedback (0-1)
+     */
+    score: number;
+    /**
+     * The Session ID.
+     */
+    sessionId: string;
+    /**
+     * The text to be given as feedback.
+     */
+    text: string;
+    /**
+     * The date and time in GMT when the Feedback was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the Feedback was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateUpdated: Date;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        assistantId: string;
+        id: string;
+        accountSid: string;
+        userSid: string;
+        messageId: string;
+        score: number;
+        sessionId: string;
+        text: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class FeedbackPage extends Page<V1, FeedbackPayload, FeedbackResource, FeedbackInstance> {
+    /**
+     * Initialize the FeedbackPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: FeedbackSolution);
+    /**
+     * Build an instance of FeedbackInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: FeedbackResource): FeedbackInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/assistants/v1/assistant/feedback.js

@@ -0,0 +1,161 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Assistants
+ * 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.FeedbackPage = exports.FeedbackInstance = exports.FeedbackListInstance = exports.AssistantsV1ServiceCreateFeedbackRequest = 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 AssistantsV1ServiceCreateFeedbackRequest {
+}
+exports.AssistantsV1ServiceCreateFeedbackRequest = AssistantsV1ServiceCreateFeedbackRequest;
+function FeedbackListInstance(version, id) {
+    if (!(0, utility_1.isValidPathParam)(id)) {
+        throw new Error("Parameter 'id' is not valid.");
+    }
+    const instance = {};
+    instance._version = version;
+    instance._solution = { id };
+    instance._uri = `/Assistants/${id}/Feedbacks`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        const headers = {};
+        headers["Content-Type"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new FeedbackInstance(operationVersion, payload, instance._solution.id));
+        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 FeedbackPage(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 FeedbackPage(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.FeedbackListInstance = FeedbackListInstance;
+class FeedbackInstance {
+    constructor(_version, payload, id) {
+        this._version = _version;
+        this.assistantId = payload.assistant_id;
+        this.id = payload.id;
+        this.accountSid = payload.account_sid;
+        this.userSid = payload.user_sid;
+        this.messageId = payload.message_id;
+        this.score = payload.score;
+        this.sessionId = payload.session_id;
+        this.text = payload.text;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            assistantId: this.assistantId,
+            id: this.id,
+            accountSid: this.accountSid,
+            userSid: this.userSid,
+            messageId: this.messageId,
+            score: this.score,
+            sessionId: this.sessionId,
+            text: this.text,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.FeedbackInstance = FeedbackInstance;
+class FeedbackPage extends Page_1.default {
+    /**
+     * Initialize the FeedbackPage
+     *
+     * @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 FeedbackInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new FeedbackInstance(this._version, payload, this._solution.id);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.FeedbackPage = FeedbackPage;

package/lib/rest/assistants/v1/assistant/message.d.ts

@@ -0,0 +1,112 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V1 from "../../V1";
+export declare class AssistantsV1ServiceAssistantSendMessageRequest {
+    /**
+     * The unique identity of user for the session.
+     */
+    "identity": string;
+    /**
+     * The unique name for the session.
+     */
+    "sessionId"?: string;
+    /**
+     * The query to ask the assistant.
+     */
+    "body": string;
+    /**
+     * The webhook url to call after the assistant has generated a response or report an error.
+     */
+    "webhook"?: string;
+    /**
+     * one of the modes \'chat\', \'email\' or \'voice\'
+     */
+    "mode"?: string;
+}
+/**
+ * Options to pass to create a MessageInstance
+ */
+export interface MessageListInstanceCreateOptions {
+    /**  */
+    assistantsV1ServiceAssistantSendMessageRequest: AssistantsV1ServiceAssistantSendMessageRequest;
+}
+export interface MessageSolution {
+    id: string;
+}
+export interface MessageListInstance {
+    _version: V1;
+    _solution: MessageSolution;
+    _uri: string;
+    /**
+     * Create a MessageInstance
+     *
+     * @param params - Body for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed MessageInstance
+     */
+    create(params: AssistantsV1ServiceAssistantSendMessageRequest, callback?: (error: Error | null, item?: MessageInstance) => any): Promise<MessageInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function MessageListInstance(version: V1, id: string): MessageListInstance;
+interface MessageResource {
+    status: string;
+    flagged: boolean;
+    aborted: boolean;
+    session_id: string;
+    account_sid: string;
+    body: string;
+    error: string;
+}
+export declare class MessageInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: MessageResource, id: string);
+    /**
+     * success or failure based on whether the request successfully generated a response.
+     */
+    status: string;
+    /**
+     * If successful, this property will denote whether the response was flagged or not.
+     */
+    flagged: boolean;
+    /**
+     * This property will denote whether the request was aborted or not.
+     */
+    aborted: boolean;
+    /**
+     * The unique name for the session.
+     */
+    sessionId: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that sent the Message.
+     */
+    accountSid: string;
+    /**
+     * If successful, the body of the generated response
+     */
+    body: string;
+    /**
+     * The error message if generation was not successful
+     */
+    error: string;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        status: string;
+        flagged: boolean;
+        aborted: boolean;
+        sessionId: string;
+        accountSid: string;
+        body: string;
+        error: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/assistants/v1/assistant/message.js

@@ -0,0 +1,90 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Assistants
+ * This is the public Twilio REST API.
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageInstance = exports.MessageListInstance = exports.AssistantsV1ServiceAssistantSendMessageRequest = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../../base/deserialize");
+const serialize = require("../../../../base/serialize");
+const utility_1 = require("../../../../base/utility");
+class AssistantsV1ServiceAssistantSendMessageRequest {
+}
+exports.AssistantsV1ServiceAssistantSendMessageRequest = AssistantsV1ServiceAssistantSendMessageRequest;
+function MessageListInstance(version, id) {
+    if (!(0, utility_1.isValidPathParam)(id)) {
+        throw new Error("Parameter 'id' is not valid.");
+    }
+    const instance = {};
+    instance._version = version;
+    instance._solution = { id };
+    instance._uri = `/Assistants/${id}/Messages`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        const headers = {};
+        headers["Content-Type"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new MessageInstance(operationVersion, payload, instance._solution.id));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    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.MessageListInstance = MessageListInstance;
+class MessageInstance {
+    constructor(_version, payload, id) {
+        this._version = _version;
+        this.status = payload.status;
+        this.flagged = payload.flagged;
+        this.aborted = payload.aborted;
+        this.sessionId = payload.session_id;
+        this.accountSid = payload.account_sid;
+        this.body = payload.body;
+        this.error = payload.error;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            status: this.status,
+            flagged: this.flagged,
+            aborted: this.aborted,
+            sessionId: this.sessionId,
+            accountSid: this.accountSid,
+            body: this.body,
+            error: this.error,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.MessageInstance = MessageInstance;