twilio 6.0.0 → 6.0.2

package/lib/rest/conversations/v2/communication.js

@@ -0,0 +1,436 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Conversation Orchestrator
+ * Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use conversations to group related communications.
+ *
+ * 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.CommunicationPage = exports.CommunicationInstance = exports.CommunicationContextImpl = exports.ListCommunicationByConversation200ResponseCommunicationsRecipients = exports.ListCommunicationByConversation200ResponseCommunicationsContent = exports.CreateCommunicationInConversationRequestContent = exports.CreateCommunicationInConversationRequestAuthor = exports.CreateCommunicationInConversationRequest = exports.ConversationsV2ParticipantAddress = exports.ConversationsV2ContentTranscriptionTranscriptionWords = exports.ConversationsV2ContentTranscriptionTranscription = exports.ContentTranscriptionTranscription = void 0;
+exports.CommunicationListInstance = CommunicationListInstance;
+const util_1 = require("util");
+const TokenPage_1 = __importDefault(require("../../../base/TokenPage"));
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class ContentTranscriptionTranscription {
+    constructor(payload) {
+        this.channel = payload["channel"];
+        this.confidence = payload["confidence"];
+        this.engine = payload["engine"];
+    }
+}
+exports.ContentTranscriptionTranscription = ContentTranscriptionTranscription;
+/**
+ * Transcription metadata.
+ */
+class ConversationsV2ContentTranscriptionTranscription {
+    constructor(payload) {
+        this.channel = payload["channel"];
+        this.confidence = payload["confidence"];
+        this.engine = payload["engine"];
+        this.words = payload["words"];
+    }
+}
+exports.ConversationsV2ContentTranscriptionTranscription = ConversationsV2ContentTranscriptionTranscription;
+class ConversationsV2ContentTranscriptionTranscriptionWords {
+    constructor(payload) {
+        this.text = payload["text"];
+        this.startTime = payload["startTime"];
+        this.endTime = payload["endTime"];
+    }
+}
+exports.ConversationsV2ContentTranscriptionTranscriptionWords = ConversationsV2ContentTranscriptionTranscriptionWords;
+class ConversationsV2ParticipantAddress {
+    constructor(payload) {
+        this.address = payload["address"];
+        this.channel = payload["channel"];
+        this.participantId = payload["participantId"];
+    }
+}
+exports.ConversationsV2ParticipantAddress = ConversationsV2ParticipantAddress;
+class CreateCommunicationInConversationRequest {
+    constructor(payload) {
+        this.author = payload["author"];
+        this.content = payload["content"];
+        this.channelId = payload["channelId"];
+        this.recipients = payload["recipients"];
+    }
+}
+exports.CreateCommunicationInConversationRequest = CreateCommunicationInConversationRequest;
+class CreateCommunicationInConversationRequestAuthor {
+    constructor(payload) {
+        this.address = payload["address"];
+        this.channel = payload["channel"];
+        this.participantId = payload["participantId"];
+    }
+}
+exports.CreateCommunicationInConversationRequestAuthor = CreateCommunicationInConversationRequestAuthor;
+/**
+ * The content of the Communication.
+ */
+class CreateCommunicationInConversationRequestContent {
+    constructor(payload) {
+        this.type = payload["type"];
+        this.text = payload["text"];
+        this.transcription = payload["transcription"];
+    }
+}
+exports.CreateCommunicationInConversationRequestContent = CreateCommunicationInConversationRequestContent;
+/**
+ * The content of the Communication using type field for discrimination.
+ */
+class ListCommunicationByConversation200ResponseCommunicationsContent {
+    constructor(payload) {
+        this.type = payload["type"];
+        this.text = payload["text"];
+        this.transcription = payload["transcription"];
+    }
+}
+exports.ListCommunicationByConversation200ResponseCommunicationsContent = ListCommunicationByConversation200ResponseCommunicationsContent;
+class ListCommunicationByConversation200ResponseCommunicationsRecipients {
+    constructor(payload) {
+        this.address = payload["address"];
+        this.channel = payload["channel"];
+        this.participantId = payload["participantId"];
+        this.deliveryStatus = payload["deliveryStatus"];
+    }
+}
+exports.ListCommunicationByConversation200ResponseCommunicationsRecipients = ListCommunicationByConversation200ResponseCommunicationsRecipients;
+class CommunicationContextImpl {
+    constructor(_version, conversationSid, sid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(conversationSid)) {
+            throw new Error("Parameter 'conversationSid' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(sid)) {
+            throw new Error("Parameter 'sid' is not valid.");
+        }
+        this._solution = { conversationSid, sid };
+        this._uri = `/Conversations/${conversationSid}/Communications/${sid}`;
+    }
+    fetch(callback) {
+        const headers = {};
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new CommunicationInstance(operationVersion, payload, instance._solution.conversationSid, instance._solution.sid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    fetchWithHttpInfo(callback) {
+        const headers = {};
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .fetchWithResponseInfo({
+            uri: instance._uri,
+            method: "get",
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new CommunicationInstance(operationVersion, response.body, instance._solution.conversationSid, instance._solution.sid),
+        }));
+        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.CommunicationContextImpl = CommunicationContextImpl;
+class CommunicationInstance {
+    constructor(_version, _payload, conversationSid, sid) {
+        this._version = _version;
+        const payload = _payload;
+        this.id = payload.id;
+        this.conversationId = payload.conversationId;
+        this.accountId = payload.accountId;
+        this.author =
+            payload.author !== null && payload.author !== undefined
+                ? new ConversationsV2ParticipantAddress(payload.author)
+                : null;
+        this.content =
+            payload.content !== null && payload.content !== undefined
+                ? new ListCommunicationByConversation200ResponseCommunicationsContent(payload.content)
+                : null;
+        this.channelId = payload.channelId;
+        this.resourceId = payload.resourceId;
+        this.recipients =
+            payload.recipients !== null && payload.recipients !== undefined
+                ? payload.recipients.map((payload) => new ListCommunicationByConversation200ResponseCommunicationsRecipients(payload))
+                : null;
+        this.createdAt = deserialize.iso8601DateTime(payload.createdAt);
+        this.updatedAt = deserialize.iso8601DateTime(payload.updatedAt);
+        this.occurredAt = deserialize.iso8601DateTime(payload.occurredAt);
+        this._solution = { conversationSid, sid: sid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new CommunicationContextImpl(this._version, this._solution.conversationSid, this._solution.sid);
+        return this._context;
+    }
+    /**
+     * Fetch a CommunicationInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed CommunicationInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Fetch a CommunicationInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed CommunicationInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback) {
+        return this._proxy.fetchWithHttpInfo(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            conversationId: this.conversationId,
+            accountId: this.accountId,
+            author: this.author,
+            content: this.content,
+            channelId: this.channelId,
+            resourceId: this.resourceId,
+            recipients: this.recipients,
+            createdAt: this.createdAt,
+            updatedAt: this.updatedAt,
+            occurredAt: this.occurredAt,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.CommunicationInstance = CommunicationInstance;
+function CommunicationListInstance(version, conversationSid) {
+    if (!(0, utility_1.isValidPathParam)(conversationSid)) {
+        throw new Error("Parameter 'conversationSid' is not valid.");
+    }
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new CommunicationContextImpl(version, conversationSid, sid);
+    };
+    instance._version = version;
+    instance._solution = { conversationSid };
+    instance._uri = `/Conversations/${conversationSid}/Communications`;
+    instance.create = function create(params, headers, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params =
+                {};
+        }
+        else {
+            params =
+                params ||
+                    {};
+        }
+        let data = {};
+        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 CommunicationInstance(operationVersion, payload, instance._solution.conversationSid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.createWithHttpInfo = function createWithHttpInfo(params, headers, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params =
+                {};
+        }
+        else {
+            params =
+                params ||
+                    {};
+        }
+        let data = {};
+        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 CommunicationInstance(operationVersion, response.body, instance._solution.conversationSid),
+        }));
+        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["channelId"] !== undefined)
+            data["channelId"] = params["channelId"];
+        if (params["pageSize"] !== undefined)
+            data["pageSize"] = params["pageSize"];
+        if (params["pageToken"] !== undefined)
+            data["pageToken"] = params["pageToken"];
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new CommunicationPage(operationVersion, payload, instance._uri, data, 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 CommunicationPage(instance._version, payload, instance._uri, {}, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    instance.pageWithHttpInfo = function pageWithHttpInfo(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["channelId"] !== undefined)
+            data["channelId"] = params["channelId"];
+        if (params["pageSize"] !== undefined)
+            data["pageSize"] = params["pageSize"];
+        if (params["pageToken"] !== undefined)
+            data["pageToken"] = params["pageToken"];
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version;
+        // For page operations, use page() directly as it already returns { statusCode, body, headers }
+        // IMPORTANT: Pass full response to Page constructor, not response.body
+        let operationPromise = operationVersion
+            .page({ uri: instance._uri, method: "get", params: data, headers })
+            .then((response) => ({
+            statusCode: response.statusCode,
+            headers: response.headers,
+            body: new CommunicationPage(operationVersion, response, instance._uri, data, instance._solution),
+        }));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.eachWithHttpInfo = instance._version.eachWithHttpInfo;
+    instance.list = instance._version.list;
+    instance.listWithHttpInfo = instance._version.listWithHttpInfo;
+    instance.getPageWithHttpInfo = function getPageWithHttpInfo(targetUrl, callback) {
+        // Use request() directly as it already returns { statusCode, body, headers }
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((response) => ({
+            statusCode: response.statusCode,
+            headers: response.headers,
+            body: new CommunicationPage(instance._version, response, instance._uri, {}, 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;
+}
+class CommunicationPage extends TokenPage_1.default {
+    /**
+     * Initialize the CommunicationPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param uri - URI of the resource
+     * @param params - Query parameters
+     * @param solution - Path solution
+     */
+    constructor(version, response, uri, params, solution) {
+        super(version, response, uri, params, solution);
+    }
+    /**
+     * Build an instance of CommunicationInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new CommunicationInstance(this._version, payload, this._solution.conversationSid);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.CommunicationPage = CommunicationPage;