twilio 5.13.1 → 6.0.1

package/lib/rest/insights/v3/query.js

@@ -0,0 +1,214 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Insights
+ * Insights Domain V3 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.QueryInstance = exports.QueryDefinitionOrderBy = exports.QueryDefinitionFiltersExpressions = exports.QueryDefinitionFilters = exports.QueryDefinition = exports.PaginationMeta = exports.InsightsQueryRequest = void 0;
+exports.QueryListInstance = QueryListInstance;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+class InsightsQueryRequest {
+    constructor(payload) {
+        this.domain = payload["domain"];
+        this.query = payload["query"];
+    }
+}
+exports.InsightsQueryRequest = InsightsQueryRequest;
+/**
+ * Pagination metadata containing navigation tokens and result information, this schema should according to convention be added to the response payload\'s \'meta\' attribute
+ */
+class PaginationMeta {
+    constructor(payload) {
+        this.key = payload["key"];
+        this.pageSize = payload["pageSize"];
+        this.previousToken = payload["previousToken"];
+        this.nextToken = payload["nextToken"];
+    }
+}
+exports.PaginationMeta = PaginationMeta;
+/**
+ * Structured query definition that specifies what data to retrieve and how to filter, group, and order it
+ */
+class QueryDefinition {
+    constructor(payload) {
+        this.measures = payload["measures"];
+        this.dimensions = payload["dimensions"];
+        this.filters = payload["filters"];
+        this.orderBy = payload["orderBy"];
+    }
+}
+exports.QueryDefinition = QueryDefinition;
+class QueryDefinitionFilters {
+    constructor(payload) {
+        this.op = payload["op"];
+        this.expressions = payload["expressions"];
+    }
+}
+exports.QueryDefinitionFilters = QueryDefinitionFilters;
+class QueryDefinitionFiltersExpressions {
+    constructor(payload) {
+        this.op = payload["op"];
+        this.field = payload["field"];
+        this.values = payload["values"];
+    }
+}
+exports.QueryDefinitionFiltersExpressions = QueryDefinitionFiltersExpressions;
+class QueryDefinitionOrderBy {
+    constructor(payload) {
+        this.field = payload["field"];
+        this.direction = payload["direction"];
+    }
+}
+exports.QueryDefinitionOrderBy = QueryDefinitionOrderBy;
+function QueryListInstance(version) {
+    const instance = {};
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/InsightsDomains/Conversations/Query`;
+    instance.create = function create(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["pageSize"] = params["pageSize"];
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new QueryInstance(operationVersion, payload));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.createWithHttpInfo = function createWithHttpInfo(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["pageSize"] = params["pageSize"];
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .createWithResponseInfo({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new QueryInstance(operationVersion, response.body),
+        }));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.fetch = function fetch(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["pageToken"] === null || params["pageToken"] === undefined) {
+            throw new Error("Required parameter \"params['pageToken']\" missing.");
+        }
+        let data = {};
+        data["pageToken"] = params["pageToken"];
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new QueryInstance(operationVersion, payload));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.fetchWithHttpInfo = function fetchWithHttpInfo(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["pageToken"] === null || params["pageToken"] === undefined) {
+            throw new Error("Required parameter \"params['pageToken']\" missing.");
+        }
+        let data = {};
+        data["pageToken"] = params["pageToken"];
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .fetchWithResponseInfo({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new QueryInstance(operationVersion, response.body),
+        }));
+        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;
+}
+class QueryInstance {
+    constructor(_version, _payload) {
+        this._version = _version;
+        const payload = _payload;
+        this.domain = payload.domain;
+        this.items = payload.items;
+        this.meta =
+            payload.meta !== null && payload.meta !== undefined
+                ? new PaginationMeta(payload.meta)
+                : null;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            domain: this.domain,
+            items: this.items,
+            meta: this.meta,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.QueryInstance = QueryInstance;

package/lib/rest/intelligence/V3.d.ts

@@ -0,0 +1,35 @@
+import IntelligenceBase from "../IntelligenceBase";
+import Version from "../../base/Version";
+import { ConfigurationListInstance } from "./v3/configuration";
+import { ConversationListInstance } from "./v3/conversation";
+import { OperatorListInstance } from "./v3/operator";
+import { OperatorResultListInstance } from "./v3/operatorResult";
+import { VersionListInstance, VersionContext } from "./v3/version";
+export default class V3 extends Version {
+    /**
+     * Initialize the V3 version of Intelligence
+     *
+     * @param domain - The Twilio (Twilio.Intelligence) domain
+     */
+    constructor(domain: IntelligenceBase);
+    /** configurations - { Twilio.Intelligence.V3.ConfigurationListInstance } resource */
+    protected _configurations?: ConfigurationListInstance;
+    /** conversations - { Twilio.Intelligence.V3.ConversationListInstance } resource */
+    protected _conversations?: ConversationListInstance;
+    /** operators - { Twilio.Intelligence.V3.OperatorListInstance } resource */
+    protected _operators?: OperatorListInstance;
+    /** operatorResults - { Twilio.Intelligence.V3.OperatorResultListInstance } resource */
+    protected _operatorResults?: OperatorResultListInstance;
+    /** Getter for configurations resource */
+    get configurations(): ConfigurationListInstance;
+    /** Getter for conversations resource */
+    get conversations(): ConversationListInstance;
+    /** Getter for operators resource */
+    get operators(): OperatorListInstance;
+    /** Getter for operatorResults resource */
+    get operatorResults(): OperatorResultListInstance;
+    /** Accessor for versions resource - list operations */
+    versions(id: string): VersionListInstance;
+    /** Accessor for versions resource - instance operations */
+    versions(id: string, version: number): VersionContext;
+}

package/lib/rest/intelligence/V3.js

@@ -0,0 +1,65 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio Conversational Intelligence API
+ * The Conversational Intelligence API includes resources to create and manage intelligence configurations, define and run language operators, and retrieve processed conversations and operator results.  * Use the Configurations resource to create and manage intelligence configurations and define rules that control how and when language operators analyze and transform conversations.  * Use the Operators resource to create custom language operators or retrieve Twilio-author and custom operators. * Use the Conversations resource to retrieve conversations processed with an intelligence configuration, and the OperatorResults resource to retrieve language operator results for those conversations.
+ *
+ * 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 });
+const Version_1 = __importDefault(require("../../base/Version"));
+const configuration_1 = require("./v3/configuration");
+const conversation_1 = require("./v3/conversation");
+const operator_1 = require("./v3/operator");
+const operatorResult_1 = require("./v3/operatorResult");
+const version_1 = require("./v3/version");
+class V3 extends Version_1.default {
+    /**
+     * Initialize the V3 version of Intelligence
+     *
+     * @param domain - The Twilio (Twilio.Intelligence) domain
+     */
+    constructor(domain) {
+        super(domain, "v3");
+    }
+    /** Getter for configurations resource */
+    get configurations() {
+        this._configurations =
+            this._configurations || (0, configuration_1.ConfigurationListInstance)(this);
+        return this._configurations;
+    }
+    /** Getter for conversations resource */
+    get conversations() {
+        this._conversations = this._conversations || (0, conversation_1.ConversationListInstance)(this);
+        return this._conversations;
+    }
+    /** Getter for operators resource */
+    get operators() {
+        this._operators = this._operators || (0, operator_1.OperatorListInstance)(this);
+        return this._operators;
+    }
+    /** Getter for operatorResults resource */
+    get operatorResults() {
+        this._operatorResults =
+            this._operatorResults || (0, operatorResult_1.OperatorResultListInstance)(this);
+        return this._operatorResults;
+    }
+    /** Implementation */
+    versions(id, version) {
+        const listInstance = (0, version_1.VersionListInstance)(this, id);
+        if (version !== undefined) {
+            return listInstance.get(version);
+        }
+        return listInstance;
+    }
+}
+exports.default = V3;