twilio 4.0.0 → 4.0.1

package/dist/lib/rest/conversations/v1/service/conversation.js

@@ -1,353 +0,0 @@
-"use strict";
-/*
- * This code was generated by
- * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
- *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
- *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
- *
- * Twilio - Conversations
- * 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.ConversationPage = exports.ConversationListInstance = exports.ConversationInstance = exports.ConversationContextImpl = 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");
-const message_1 = require("./conversation/message");
-const participant_1 = require("./conversation/participant");
-const webhook_1 = require("./conversation/webhook");
-class ConversationContextImpl {
-    constructor(_version, chatServiceSid, sid) {
-        this._version = _version;
-        if (!(0, utility_1.isValidPathParam)(chatServiceSid)) {
-            throw new Error("Parameter 'chatServiceSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(sid)) {
-            throw new Error("Parameter 'sid' is not valid.");
-        }
-        this._solution = { chatServiceSid, sid };
-        this._uri = `/Services/${chatServiceSid}/Conversations/${sid}`;
-    }
-    get messages() {
-        this._messages =
-            this._messages ||
-                (0, message_1.MessageListInstance)(this._version, this._solution.chatServiceSid, this._solution.sid);
-        return this._messages;
-    }
-    get participants() {
-        this._participants =
-            this._participants ||
-                (0, participant_1.ParticipantListInstance)(this._version, this._solution.chatServiceSid, this._solution.sid);
-        return this._participants;
-    }
-    get webhooks() {
-        this._webhooks =
-            this._webhooks ||
-                (0, webhook_1.WebhookListInstance)(this._version, this._solution.chatServiceSid, this._solution.sid);
-        return this._webhooks;
-    }
-    remove(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        const headers = {};
-        if (params["xTwilioWebhookEnabled"] !== undefined)
-            headers["X-Twilio-Webhook-Enabled"] = params["xTwilioWebhookEnabled"];
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.remove({
-            uri: instance._uri,
-            method: "delete",
-            params: data,
-            headers,
-        });
-        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
-        return operationPromise;
-    }
-    fetch(callback) {
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
-            uri: instance._uri,
-            method: "get",
-        });
-        operationPromise = operationPromise.then((payload) => new ConversationInstance(operationVersion, payload, instance._solution.chatServiceSid, instance._solution.sid));
-        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
-        return operationPromise;
-    }
-    update(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        if (params["friendlyName"] !== undefined)
-            data["FriendlyName"] = params["friendlyName"];
-        if (params["dateCreated"] !== undefined)
-            data["DateCreated"] = serialize.iso8601DateTime(params["dateCreated"]);
-        if (params["dateUpdated"] !== undefined)
-            data["DateUpdated"] = serialize.iso8601DateTime(params["dateUpdated"]);
-        if (params["attributes"] !== undefined)
-            data["Attributes"] = params["attributes"];
-        if (params["messagingServiceSid"] !== undefined)
-            data["MessagingServiceSid"] = params["messagingServiceSid"];
-        if (params["state"] !== undefined)
-            data["State"] = params["state"];
-        if (params["timers.inactive"] !== undefined)
-            data["Timers.Inactive"] = params["timers.inactive"];
-        if (params["timers.closed"] !== undefined)
-            data["Timers.Closed"] = params["timers.closed"];
-        if (params["uniqueName"] !== undefined)
-            data["UniqueName"] = params["uniqueName"];
-        const headers = {};
-        headers["Content-Type"] = "application/x-www-form-urlencoded";
-        if (params["xTwilioWebhookEnabled"] !== undefined)
-            headers["X-Twilio-Webhook-Enabled"] = params["xTwilioWebhookEnabled"];
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.update({
-            uri: instance._uri,
-            method: "post",
-            data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new ConversationInstance(operationVersion, payload, instance._solution.chatServiceSid, 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.ConversationContextImpl = ConversationContextImpl;
-class ConversationInstance {
-    constructor(_version, payload, chatServiceSid, sid) {
-        this._version = _version;
-        this.accountSid = payload.account_sid;
-        this.chatServiceSid = payload.chat_service_sid;
-        this.messagingServiceSid = payload.messaging_service_sid;
-        this.sid = payload.sid;
-        this.friendlyName = payload.friendly_name;
-        this.uniqueName = payload.unique_name;
-        this.attributes = payload.attributes;
-        this.state = payload.state;
-        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
-        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
-        this.timers = payload.timers;
-        this.url = payload.url;
-        this.links = payload.links;
-        this.bindings = payload.bindings;
-        this._solution = { chatServiceSid, sid: sid || this.sid };
-    }
-    get _proxy() {
-        this._context =
-            this._context ||
-                new ConversationContextImpl(this._version, this._solution.chatServiceSid, this._solution.sid);
-        return this._context;
-    }
-    remove(params, callback) {
-        return this._proxy.remove(params, callback);
-    }
-    /**
-     * Fetch a ConversationInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ConversationInstance
-     */
-    fetch(callback) {
-        return this._proxy.fetch(callback);
-    }
-    update(params, callback) {
-        return this._proxy.update(params, callback);
-    }
-    /**
-     * Access the messages.
-     */
-    messages() {
-        return this._proxy.messages;
-    }
-    /**
-     * Access the participants.
-     */
-    participants() {
-        return this._proxy.participants;
-    }
-    /**
-     * Access the webhooks.
-     */
-    webhooks() {
-        return this._proxy.webhooks;
-    }
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON() {
-        return {
-            accountSid: this.accountSid,
-            chatServiceSid: this.chatServiceSid,
-            messagingServiceSid: this.messagingServiceSid,
-            sid: this.sid,
-            friendlyName: this.friendlyName,
-            uniqueName: this.uniqueName,
-            attributes: this.attributes,
-            state: this.state,
-            dateCreated: this.dateCreated,
-            dateUpdated: this.dateUpdated,
-            timers: this.timers,
-            url: this.url,
-            links: this.links,
-            bindings: this.bindings,
-        };
-    }
-    [util_1.inspect.custom](_depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.ConversationInstance = ConversationInstance;
-function ConversationListInstance(version, chatServiceSid) {
-    if (!(0, utility_1.isValidPathParam)(chatServiceSid)) {
-        throw new Error("Parameter 'chatServiceSid' is not valid.");
-    }
-    const instance = ((sid) => instance.get(sid));
-    instance.get = function get(sid) {
-        return new ConversationContextImpl(version, chatServiceSid, sid);
-    };
-    instance._version = version;
-    instance._solution = { chatServiceSid };
-    instance._uri = `/Services/${chatServiceSid}/Conversations`;
-    instance.create = function create(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        if (params["friendlyName"] !== undefined)
-            data["FriendlyName"] = params["friendlyName"];
-        if (params["uniqueName"] !== undefined)
-            data["UniqueName"] = params["uniqueName"];
-        if (params["attributes"] !== undefined)
-            data["Attributes"] = params["attributes"];
-        if (params["messagingServiceSid"] !== undefined)
-            data["MessagingServiceSid"] = params["messagingServiceSid"];
-        if (params["dateCreated"] !== undefined)
-            data["DateCreated"] = serialize.iso8601DateTime(params["dateCreated"]);
-        if (params["dateUpdated"] !== undefined)
-            data["DateUpdated"] = serialize.iso8601DateTime(params["dateUpdated"]);
-        if (params["state"] !== undefined)
-            data["State"] = params["state"];
-        if (params["timers.inactive"] !== undefined)
-            data["Timers.Inactive"] = params["timers.inactive"];
-        if (params["timers.closed"] !== undefined)
-            data["Timers.Closed"] = params["timers.closed"];
-        const headers = {};
-        headers["Content-Type"] = "application/x-www-form-urlencoded";
-        if (params["xTwilioWebhookEnabled"] !== undefined)
-            headers["X-Twilio-Webhook-Enabled"] = params["xTwilioWebhookEnabled"];
-        let operationVersion = version, operationPromise = operationVersion.create({
-            uri: instance._uri,
-            method: "post",
-            data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new ConversationInstance(operationVersion, payload, instance._solution.chatServiceSid));
-        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 ConversationPage(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 ConversationPage(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.ConversationListInstance = ConversationListInstance;
-class ConversationPage extends Page_1.default {
-    /**
-     * Initialize the ConversationPage
-     *
-     * @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 ConversationInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload) {
-        return new ConversationInstance(this._version, payload, this._solution.chatServiceSid);
-    }
-    [util_1.inspect.custom](depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.ConversationPage = ConversationPage;

package/dist/lib/rest/conversations/v1/service/participantConversation.d.ts

@@ -1,243 +0,0 @@
-/// <reference types="node" />
-import { inspect, InspectOptions } from "util";
-import Page, { TwilioResponsePayload } from "../../../../base/Page";
-import Response from "../../../../http/response";
-import V1 from "../../V1";
-type ServiceParticipantConversationState = "inactive" | "active" | "closed";
-/**
- * Options to pass to each
- */
-export interface ParticipantConversationListInstanceEachOptions {
-    /** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. */
-    identity?: string;
-    /** A unique string identifier for the conversation participant who\'s not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded. */
-    address?: 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: ParticipantConversationInstance, 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 ParticipantConversationListInstanceOptions {
-    /** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. */
-    identity?: string;
-    /** A unique string identifier for the conversation participant who\'s not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded. */
-    address?: 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 ParticipantConversationListInstancePageOptions {
-    /** A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters. */
-    identity?: string;
-    /** A unique string identifier for the conversation participant who\'s not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded. */
-    address?: 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 ParticipantConversationSolution {
-    chatServiceSid: string;
-}
-export interface ParticipantConversationListInstance {
-    _version: V1;
-    _solution: ParticipantConversationSolution;
-    _uri: string;
-    /**
-     * Streams ParticipantConversationInstance 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 { ParticipantConversationListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: ParticipantConversationInstance, done: (err?: Error) => void) => void): void;
-    each(params: ParticipantConversationListInstanceEachOptions, callback?: (item: ParticipantConversationInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of ParticipantConversationInstance 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: ParticipantConversationPage) => any): Promise<ParticipantConversationPage>;
-    /**
-     * Lists ParticipantConversationInstance 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 { ParticipantConversationListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: ParticipantConversationInstance[]) => any): Promise<ParticipantConversationInstance[]>;
-    list(params: ParticipantConversationListInstanceOptions, callback?: (error: Error | null, items: ParticipantConversationInstance[]) => any): Promise<ParticipantConversationInstance[]>;
-    /**
-     * Retrieve a single page of ParticipantConversationInstance 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 { ParticipantConversationListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: ParticipantConversationPage) => any): Promise<ParticipantConversationPage>;
-    page(params: ParticipantConversationListInstancePageOptions, callback?: (error: Error | null, items: ParticipantConversationPage) => any): Promise<ParticipantConversationPage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function ParticipantConversationListInstance(version: V1, chatServiceSid: string): ParticipantConversationListInstance;
-interface ParticipantConversationPayload extends TwilioResponsePayload {
-    conversations: ParticipantConversationResource[];
-}
-interface ParticipantConversationResource {
-    account_sid: string;
-    chat_service_sid: string;
-    participant_sid: string;
-    participant_user_sid: string;
-    participant_identity: string;
-    participant_messaging_binding: any;
-    conversation_sid: string;
-    conversation_unique_name: string;
-    conversation_friendly_name: string;
-    conversation_attributes: string;
-    conversation_date_created: Date;
-    conversation_date_updated: Date;
-    conversation_created_by: string;
-    conversation_state: ServiceParticipantConversationState;
-    conversation_timers: any;
-    links: Record<string, string>;
-}
-export declare class ParticipantConversationInstance {
-    protected _version: V1;
-    constructor(_version: V1, payload: ParticipantConversationResource, chatServiceSid: string);
-    /**
-     * The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.
-     */
-    accountSid: string;
-    /**
-     * The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.
-     */
-    chatServiceSid: string;
-    /**
-     * The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource).
-     */
-    participantSid: string;
-    /**
-     * The unique string that identifies the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource).
-     */
-    participantUserSid: string;
-    /**
-     * A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.
-     */
-    participantIdentity: string;
-    /**
-     * Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.
-     */
-    participantMessagingBinding: any;
-    /**
-     * The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to.
-     */
-    conversationSid: string;
-    /**
-     * An application-defined string that uniquely identifies the Conversation resource.
-     */
-    conversationUniqueName: string;
-    /**
-     * The human-readable name of this conversation, limited to 256 characters. Optional.
-     */
-    conversationFriendlyName: string;
-    /**
-     * An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.
-     */
-    conversationAttributes: string;
-    /**
-     * The date that this conversation was created, given in ISO 8601 format.
-     */
-    conversationDateCreated: Date;
-    /**
-     * The date that this conversation was last updated, given in ISO 8601 format.
-     */
-    conversationDateUpdated: Date;
-    /**
-     * Identity of the creator of this Conversation.
-     */
-    conversationCreatedBy: string;
-    conversationState: ServiceParticipantConversationState;
-    /**
-     * Timer date values representing state update for this conversation.
-     */
-    conversationTimers: any;
-    /**
-     * Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation.
-     */
-    links: Record<string, string>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        accountSid: string;
-        chatServiceSid: string;
-        participantSid: string;
-        participantUserSid: string;
-        participantIdentity: string;
-        participantMessagingBinding: any;
-        conversationSid: string;
-        conversationUniqueName: string;
-        conversationFriendlyName: string;
-        conversationAttributes: string;
-        conversationDateCreated: Date;
-        conversationDateUpdated: Date;
-        conversationCreatedBy: string;
-        conversationState: ServiceParticipantConversationState;
-        conversationTimers: any;
-        links: Record<string, string>;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export declare class ParticipantConversationPage extends Page<V1, ParticipantConversationPayload, ParticipantConversationResource, ParticipantConversationInstance> {
-    /**
-     * Initialize the ParticipantConversationPage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: V1, response: Response<string>, solution: ParticipantConversationSolution);
-    /**
-     * Build an instance of ParticipantConversationInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: ParticipantConversationResource): ParticipantConversationInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};