twilio 5.2.3 → 5.3.1

package/lib/rest/assistants/v1/policy.d.ts

@@ -0,0 +1,202 @@
+/// <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 each
+ */
+export interface PolicyListInstanceEachOptions {
+    /** The tool ID. */
+    toolId?: string;
+    /** The knowledge ID. */
+    knowledgeId?: 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: PolicyInstance, 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 PolicyListInstanceOptions {
+    /** The tool ID. */
+    toolId?: string;
+    /** The knowledge ID. */
+    knowledgeId?: 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 PolicyListInstancePageOptions {
+    /** The tool ID. */
+    toolId?: string;
+    /** The knowledge ID. */
+    knowledgeId?: 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 PolicySolution {
+}
+export interface PolicyListInstance {
+    _version: V1;
+    _solution: PolicySolution;
+    _uri: string;
+    /**
+     * Streams PolicyInstance 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 { PolicyListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: PolicyInstance, done: (err?: Error) => void) => void): void;
+    each(params: PolicyListInstanceEachOptions, callback?: (item: PolicyInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of PolicyInstance 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: PolicyPage) => any): Promise<PolicyPage>;
+    /**
+     * Lists PolicyInstance 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 { PolicyListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: PolicyInstance[]) => any): Promise<PolicyInstance[]>;
+    list(params: PolicyListInstanceOptions, callback?: (error: Error | null, items: PolicyInstance[]) => any): Promise<PolicyInstance[]>;
+    /**
+     * Retrieve a single page of PolicyInstance 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 { PolicyListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: PolicyPage) => any): Promise<PolicyPage>;
+    page(params: PolicyListInstancePageOptions, callback?: (error: Error | null, items: PolicyPage) => any): Promise<PolicyPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function PolicyListInstance(version: V1): PolicyListInstance;
+interface PolicyPayload extends TwilioResponsePayload {
+    policies: PolicyResource[];
+}
+interface PolicyResource {
+    id: string;
+    name: string;
+    description: string;
+    account_sid: string;
+    user_sid: string;
+    type: string;
+    policy_details: Record<string, object>;
+    date_created: Date;
+    date_updated: Date;
+}
+export declare class PolicyInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: PolicyResource);
+    /**
+     * The Policy ID.
+     */
+    id: string;
+    /**
+     * The name of the policy.
+     */
+    name: string;
+    /**
+     * The description of the policy.
+     */
+    description: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Policy resource.
+     */
+    accountSid: string;
+    /**
+     * The SID of the User that created the Policy resource.
+     */
+    userSid: string;
+    /**
+     * The type of the policy.
+     */
+    type: string;
+    /**
+     * The details of the policy based on the type.
+     */
+    policyDetails: Record<string, object>;
+    /**
+     * The date and time in GMT when the Policy was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the Policy 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(): {
+        id: string;
+        name: string;
+        description: string;
+        accountSid: string;
+        userSid: string;
+        type: string;
+        policyDetails: Record<string, object>;
+        dateCreated: Date;
+        dateUpdated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class PolicyPage extends Page<V1, PolicyPayload, PolicyResource, PolicyInstance> {
+    /**
+     * Initialize the PolicyPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: PolicySolution);
+    /**
+     * Build an instance of PolicyInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: PolicyResource): PolicyInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/assistants/v1/policy.js

@@ -0,0 +1,138 @@
+"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.PolicyPage = exports.PolicyInstance = exports.PolicyListInstance = void 0;
+const util_1 = require("util");
+const Page_1 = __importDefault(require("../../../base/Page"));
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+function PolicyListInstance(version) {
+    const instance = {};
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Policies`;
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["toolId"] !== undefined)
+            data["ToolId"] = params["toolId"];
+        if (params["knowledgeId"] !== undefined)
+            data["KnowledgeId"] = params["knowledgeId"];
+        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 PolicyPage(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 PolicyPage(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.PolicyListInstance = PolicyListInstance;
+class PolicyInstance {
+    constructor(_version, payload) {
+        this._version = _version;
+        this.id = payload.id;
+        this.name = payload.name;
+        this.description = payload.description;
+        this.accountSid = payload.account_sid;
+        this.userSid = payload.user_sid;
+        this.type = payload.type;
+        this.policyDetails = payload.policy_details;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            name: this.name,
+            description: this.description,
+            accountSid: this.accountSid,
+            userSid: this.userSid,
+            type: this.type,
+            policyDetails: this.policyDetails,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.PolicyInstance = PolicyInstance;
+class PolicyPage extends Page_1.default {
+    /**
+     * Initialize the PolicyPage
+     *
+     * @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 PolicyInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new PolicyInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.PolicyPage = PolicyPage;

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

@@ -0,0 +1,197 @@
+/// <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 each
+ */
+export interface MessageListInstanceEachOptions {
+    /** 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: MessageInstance, 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 MessageListInstanceOptions {
+    /** 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 MessageListInstancePageOptions {
+    /** 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 MessageSolution {
+    sessionId: string;
+}
+export interface MessageListInstance {
+    _version: V1;
+    _solution: MessageSolution;
+    _uri: string;
+    /**
+     * Streams MessageInstance 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 { MessageListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: MessageInstance, done: (err?: Error) => void) => void): void;
+    each(params: MessageListInstanceEachOptions, callback?: (item: MessageInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of MessageInstance 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: MessagePage) => any): Promise<MessagePage>;
+    /**
+     * Lists MessageInstance 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 { MessageListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: MessageInstance[]) => any): Promise<MessageInstance[]>;
+    list(params: MessageListInstanceOptions, callback?: (error: Error | null, items: MessageInstance[]) => any): Promise<MessageInstance[]>;
+    /**
+     * Retrieve a single page of MessageInstance 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 { MessageListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: MessagePage) => any): Promise<MessagePage>;
+    page(params: MessageListInstancePageOptions, callback?: (error: Error | null, items: MessagePage) => any): Promise<MessagePage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function MessageListInstance(version: V1, sessionId: string): MessageListInstance;
+interface MessagePayload extends TwilioResponsePayload {
+    messages: MessageResource[];
+}
+interface MessageResource {
+    id: string;
+    account_sid: string;
+    assistant_id: string;
+    session_id: string;
+    identity: string;
+    role: string;
+    content: Record<string, object>;
+    meta: Record<string, object>;
+    date_created: Date;
+    date_updated: Date;
+}
+export declare class MessageInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: MessageResource, sessionId: string);
+    /**
+     * The message ID.
+     */
+    id: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resource.
+     */
+    accountSid: string;
+    /**
+     * The Assistant ID.
+     */
+    assistantId: string;
+    /**
+     * The Session ID.
+     */
+    sessionId: string;
+    /**
+     * The identity of the user.
+     */
+    identity: string;
+    /**
+     * The role of the user associated with the message.
+     */
+    role: string;
+    /**
+     * The content of the message.
+     */
+    content: Record<string, object>;
+    /**
+     * The metadata of the message.
+     */
+    meta: Record<string, object>;
+    /**
+     * The date and time in GMT when the Message was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the Message 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(): {
+        id: string;
+        accountSid: string;
+        assistantId: string;
+        sessionId: string;
+        identity: string;
+        role: string;
+        content: Record<string, object>;
+        meta: Record<string, object>;
+        dateCreated: Date;
+        dateUpdated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class MessagePage extends Page<V1, MessagePayload, MessageResource, MessageInstance> {
+    /**
+     * Initialize the MessagePage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: MessageSolution);
+    /**
+     * Build an instance of MessageInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: MessageResource): MessageInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,140 @@
+"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.MessagePage = exports.MessageInstance = exports.MessageListInstance = 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");
+function MessageListInstance(version, sessionId) {
+    if (!(0, utility_1.isValidPathParam)(sessionId)) {
+        throw new Error("Parameter 'sessionId' is not valid.");
+    }
+    const instance = {};
+    instance._version = version;
+    instance._solution = { sessionId };
+    instance._uri = `/Sessions/${sessionId}/Messages`;
+    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 MessagePage(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 MessagePage(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.MessageListInstance = MessageListInstance;
+class MessageInstance {
+    constructor(_version, payload, sessionId) {
+        this._version = _version;
+        this.id = payload.id;
+        this.accountSid = payload.account_sid;
+        this.assistantId = payload.assistant_id;
+        this.sessionId = payload.session_id;
+        this.identity = payload.identity;
+        this.role = payload.role;
+        this.content = payload.content;
+        this.meta = payload.meta;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            accountSid: this.accountSid,
+            assistantId: this.assistantId,
+            sessionId: this.sessionId,
+            identity: this.identity,
+            role: this.role,
+            content: this.content,
+            meta: this.meta,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.MessageInstance = MessageInstance;
+class MessagePage extends Page_1.default {
+    /**
+     * Initialize the MessagePage
+     *
+     * @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 MessageInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new MessageInstance(this._version, payload, this._solution.sessionId);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.MessagePage = MessagePage;