twilio 6.0.0 → 6.0.2

package/lib/rest/conversations/v2/action.d.ts

@@ -0,0 +1,241 @@
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+import { ApiResponse } from "../../../base/ApiResponse";
+/**
+ * Content for a SEND_MESSAGE action.
+ */
+export declare class ConversationsV2SendMessageContent {
+    /**
+     * Plain text message body.
+     */
+    "text"?: string;
+    /**
+     * Content template ID (HX... format). When provided, the template is rendered with the variables map and sent to the recipient.
+     */
+    "contentId"?: string;
+    /**
+     * Variables to substitute into the content template.
+     */
+    "variables"?: {
+        [key: string]: string;
+    };
+    /**
+     * URLs of media attachments to include with the message.
+     */
+    "mediaUrls"?: Array<string>;
+    constructor(payload: any);
+}
+/**
+ * Identifies a participant for an Action. Supports three resolution modes: 1. participantId + channel: Resolves address from participant\'s registered addresses 2. participantId only: Resolves when participant has exactly one address 3. address + channel: Uses explicit address
+ */
+export declare class ConversationsV2SendMessageParticipant {
+    /**
+     * Participant ID to resolve address from.
+     */
+    "participantId"?: string;
+    /**
+     * Explicit address formatted according to channel type.
+     */
+    "address"?: string;
+    /**
+     * Channel type for address resolution.
+     */
+    "channel"?: string;
+    constructor(payload: any);
+}
+export declare class ConversationsV2SendMessagePayload {
+    "from": ConversationsV2SendMessageParticipant;
+    /**
+     * The recipients of this action.
+     */
+    "to": Array<ConversationsV2SendMessageParticipant>;
+    "content": ConversationsV2SendMessageContent;
+    /**
+     * Channel-specific parameters forwarded as-is to the downstream sending service. Allows passing backend-specific fields without requiring API changes.
+     */
+    "channelSettings"?: {
+        [key: string]: any;
+    };
+    constructor(payload: any);
+}
+export declare class CreateConversationActionRequest {
+    /**
+     * Action type discriminator. Accepted values: SEND_MESSAGE.
+     */
+    "type": string;
+    "payload": ConversationsV2SendMessagePayload;
+    constructor(payload: any);
+}
+/**
+ * Options to pass to create a ActionInstance
+ */
+export interface ActionListInstanceCreateOptions {
+    /** The action to perform. */
+    createConversationActionRequest: CreateConversationActionRequest;
+}
+export interface ActionContext {
+    /**
+     * Fetch a ActionInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ActionInstance
+     */
+    fetch(callback?: (error: Error | null, item?: ActionInstance) => any): Promise<ActionInstance>;
+    /**
+     * Fetch a ActionInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ActionInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ActionInstance>) => any): Promise<ApiResponse<ActionInstance>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface ActionContextSolution {
+    conversationId: string;
+    actionId: string;
+}
+export declare class ActionContextImpl implements ActionContext {
+    protected _version: V2;
+    protected _solution: ActionContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, conversationId: string, actionId: string);
+    fetch(callback?: (error: Error | null, item?: ActionInstance) => any): Promise<ActionInstance>;
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ActionInstance>) => any): Promise<ApiResponse<ActionInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): ActionContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface ActionResource {
+    id: string;
+    type: string;
+    status: string;
+    conversationId: string;
+    related: {
+        [key: string]: string;
+    };
+    createdAt: Date;
+    updatedAt: Date;
+    completedAt: Date;
+}
+export declare class ActionInstance {
+    protected _version: V2;
+    protected _solution: ActionContextSolution;
+    protected _context?: ActionContext;
+    constructor(_version: V2, _payload: ActionResource, conversationId: string, actionId?: string);
+    /**
+     * Unique identifier for this Action.
+     */
+    id: string;
+    /**
+     * The type of action. Accepted values: SEND_MESSAGE.
+     */
+    type: string;
+    /**
+     * Current status of the Action. - PENDING: Action accepted, awaiting downstream confirmation - COMPLETED: Downstream backend confirmed the action - FAILED: Downstream backend reported a failure
+     */
+    status: string;
+    /**
+     * The conversation this action belongs to.
+     */
+    conversationId: string;
+    /**
+     * Named identifiers from downstream. For SEND_MESSAGE: - messageSid: The downstream message SID (present when PENDING or COMPLETED) - communicationId: The Communication ID (present when COMPLETED)
+     */
+    related: {
+        [key: string]: string;
+    };
+    /**
+     * Timestamp when the action was created.
+     */
+    createdAt: Date;
+    /**
+     * Timestamp when the action was last updated.
+     */
+    updatedAt: Date;
+    /**
+     * Timestamp when the action reached a terminal status.
+     */
+    completedAt: Date;
+    private get _proxy();
+    /**
+     * Fetch a ActionInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ActionInstance
+     */
+    fetch(callback?: (error: Error | null, item?: ActionInstance) => any): Promise<ActionInstance>;
+    /**
+     * Fetch a ActionInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ActionInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback?: (error: Error | null, item?: ApiResponse<ActionInstance>) => any): Promise<ApiResponse<ActionInstance>>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        id: string;
+        type: string;
+        status: string;
+        conversationId: string;
+        related: {
+            [key: string]: string;
+        };
+        createdAt: Date;
+        updatedAt: Date;
+        completedAt: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface ActionSolution {
+    conversationId: string;
+}
+export interface ActionListInstance {
+    _version: V2;
+    _solution: ActionSolution;
+    _uri: string;
+    (actionId: string): ActionContext;
+    get(actionId: string): ActionContext;
+    /**
+     * Create a ActionInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ActionInstance
+     */
+    create(params: CreateConversationActionRequest, headers?: any, callback?: (error: Error | null, item?: ActionInstance) => any): Promise<ActionInstance>;
+    /**
+     * Create a ActionInstance and return HTTP info
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ActionInstance with HTTP metadata
+     */
+    createWithHttpInfo(params: CreateConversationActionRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<ActionInstance>) => any): Promise<ApiResponse<ActionInstance>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function ActionListInstance(version: V2, conversationId: string): ActionListInstance;
+export {};

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

@@ -0,0 +1,246 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionInstance = exports.ActionContextImpl = exports.CreateConversationActionRequest = exports.ConversationsV2SendMessagePayload = exports.ConversationsV2SendMessageParticipant = exports.ConversationsV2SendMessageContent = void 0;
+exports.ActionListInstance = ActionListInstance;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+/**
+ * Content for a SEND_MESSAGE action.
+ */
+class ConversationsV2SendMessageContent {
+    constructor(payload) {
+        this.text = payload["text"];
+        this.contentId = payload["contentId"];
+        this.variables = payload["variables"];
+        this.mediaUrls = payload["mediaUrls"];
+    }
+}
+exports.ConversationsV2SendMessageContent = ConversationsV2SendMessageContent;
+/**
+ * Identifies a participant for an Action. Supports three resolution modes: 1. participantId + channel: Resolves address from participant\'s registered addresses 2. participantId only: Resolves when participant has exactly one address 3. address + channel: Uses explicit address
+ */
+class ConversationsV2SendMessageParticipant {
+    constructor(payload) {
+        this.participantId = payload["participantId"];
+        this.address = payload["address"];
+        this.channel = payload["channel"];
+    }
+}
+exports.ConversationsV2SendMessageParticipant = ConversationsV2SendMessageParticipant;
+class ConversationsV2SendMessagePayload {
+    constructor(payload) {
+        this.from = payload["from"];
+        this.to = payload["to"];
+        this.content = payload["content"];
+        this.channelSettings = payload["channelSettings"];
+    }
+}
+exports.ConversationsV2SendMessagePayload = ConversationsV2SendMessagePayload;
+class CreateConversationActionRequest {
+    constructor(payload) {
+        this.type = payload["type"];
+        this.payload = payload["payload"];
+    }
+}
+exports.CreateConversationActionRequest = CreateConversationActionRequest;
+class ActionContextImpl {
+    constructor(_version, conversationId, actionId) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(conversationId)) {
+            throw new Error("Parameter 'conversationId' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(actionId)) {
+            throw new Error("Parameter 'actionId' is not valid.");
+        }
+        this._solution = { conversationId, actionId };
+        this._uri = `/Conversations/${conversationId}/Actions/${actionId}`;
+    }
+    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 ActionInstance(operationVersion, payload, instance._solution.conversationId, instance._solution.actionId));
+        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 ActionInstance(operationVersion, response.body, instance._solution.conversationId, instance._solution.actionId),
+        }));
+        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.ActionContextImpl = ActionContextImpl;
+class ActionInstance {
+    constructor(_version, _payload, conversationId, actionId) {
+        this._version = _version;
+        const payload = _payload;
+        this.id = payload.id;
+        this.type = payload.type;
+        this.status = payload.status;
+        this.conversationId = payload.conversationId;
+        this.related = payload.related;
+        this.createdAt = deserialize.iso8601DateTime(payload.createdAt);
+        this.updatedAt = deserialize.iso8601DateTime(payload.updatedAt);
+        this.completedAt = deserialize.iso8601DateTime(payload.completedAt);
+        this._solution = { conversationId, actionId: actionId };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new ActionContextImpl(this._version, this._solution.conversationId, this._solution.actionId);
+        return this._context;
+    }
+    /**
+     * Fetch a ActionInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ActionInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Fetch a ActionInstance and return HTTP info
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed ActionInstance with HTTP metadata
+     */
+    fetchWithHttpInfo(callback) {
+        return this._proxy.fetchWithHttpInfo(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            type: this.type,
+            status: this.status,
+            conversationId: this.conversationId,
+            related: this.related,
+            createdAt: this.createdAt,
+            updatedAt: this.updatedAt,
+            completedAt: this.completedAt,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.ActionInstance = ActionInstance;
+function ActionListInstance(version, conversationId) {
+    if (!(0, utility_1.isValidPathParam)(conversationId)) {
+        throw new Error("Parameter 'conversationId' is not valid.");
+    }
+    const instance = ((actionId) => instance.get(actionId));
+    instance.get = function get(actionId) {
+        return new ActionContextImpl(version, conversationId, actionId);
+    };
+    instance._version = version;
+    instance._solution = { conversationId };
+    instance._uri = `/Conversations/${conversationId}/Actions`;
+    instance.create = function create(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        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 ActionInstance(operationVersion, payload, instance._solution.conversationId));
+        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 = {};
+        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 ActionInstance(operationVersion, response.body, instance._solution.conversationId),
+        }));
+        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;
+}