@twilio/conversations 2.2.1 → 3.0.0-canary.100

package/builds/lib.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
 import { SyncClient, SyncDocument, SyncList } from "twilio-sync";
 import { LogLevelDesc } from "loglevel";
-import { Transport, TwilsockClient, InitRegistration, TransportResult } from "twilsock";
-import { ConnectionState as TwilsockConnectionState } from "twilsock";
+import { TwilsockClient, InitRegistration, HttpResponse } from "twilsock";
 import { ReplayEventEmitter } from "@twilio/replay-event-emitter";
+import { JSONValue } from "@twilio/shared";
 import { ChannelType, Notifications } from "@twilio/notifications";
 import { Notifications as NotificationClient } from "@twilio/notifications";
 import { CancellablePromise, McsClient, MediaCategory, McsMedia } from "@twilio/mcs-client";
@@ -113,7 +113,7 @@ declare class Configuration {
     constructor(options: ClientOptions, configurationResponse: ConfigurationResponse, logger: Logger);
 }
 interface CommandExecutorServices {
-    transport: Transport;
+    transport: TwilsockClient;
 }
 declare class CommandExecutor {
     private _serviceUrl;
@@ -125,20 +125,6 @@ declare class CommandExecutor {
     fetchResource<REQ = void, RESP = void>(url: string, requestBody?: REQ): Promise<RESP>;
     mutateResource<REQ = void, RESP = void>(method: "post" | "delete", url: string, requestBody?: REQ): Promise<RESP>;
 }
-/**
- * Represents a JSON value.
- */
-type JSONValue = null | string | number | boolean | JSONObject | JSONArray;
-/**
- * Represents a JSON object.
- */
-type JSONObject = {
-    [x: string]: JSONValue;
-};
-/**
- * Represents a JSON array.
- */
-type JSONArray = JSONValue[];
 type UserEvents = {
     updated: (data: {
         user: User;
@@ -270,7 +256,7 @@ declare class Network {
     private cleanupCache;
     pokeTimer(): void;
     private executeWithRetry;
-    get<T>(url: string): Promise<TransportResult<T>>;
+    get<T>(url: string): Promise<HttpResponse>;
 }
 type UsersEvents = {
     userUpdated: (data: {
@@ -491,26 +477,6 @@ declare class Participant extends ReplayEventEmitter<ParticipantEvents> {
      */
     updateAttributes(attributes: JSONValue): Promise<Participant>;
 }
-interface ParticipantResponse {
-    account_sid: string;
-    chat_service_sid: string;
-    conversation_sid: string;
-    role_sid: string;
-    sid: string;
-    attributes: string;
-    date_created: string;
-    date_updated: string;
-    identity: string;
-    messaging_binding: {
-        type: "chat" | "sms" | "whatsapp" | "email";
-        address: string;
-        proxy_address: string;
-    } | null;
-    url: string;
-    links: {
-        conversation: string;
-    };
-}
 interface ParticipantBindingOptions {
     email?: ParticipantEmailBinding;
 }
@@ -752,8 +718,8 @@ interface MessageData {
     attributes?: JSONValue;
     dateUpdated: string;
     timestamp?: string;
-    medias?: Media[];
-    media?: Media;
+    medias: MediaState[] | null;
+    media: MediaState | null;
     memberSid?: string;
     delivery?: AggregatedDeliveryDescriptor;
 }
@@ -848,14 +814,6 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * Aggregated information about the message delivery statuses across all participants of a conversation..
      */
     get aggregatedDeliveryReceipt(): AggregatedDeliveryReceipt | null;
-    /**
-     * @deprecated
-     * Return a (possibly empty) array of media matching a specific set of categories.
-     * Allowed category is so far only 'media'.
-     * @param categories Array of categories to match.
-     * @returns Array of media descriptors matching given categories.
-     */
-    getMediaByCategory(categories: Array<MediaCategory>): Array<Media> | null;
     /**
      * Return a (possibly empty) array of media matching a specific set of categories.
      * Allowed category is so far only 'media'.
@@ -898,12 +856,6 @@ declare class Message extends ReplayEventEmitter<MessageEvents> {
      * @param attributes New attributes.
      */
     updateAttributes(attributes: JSONValue): Promise<Message>;
-    /**
-     * @deprecated
-     * Get content URLs for all media attachments in the given set using a single operation.
-     * @param contentSet Set of media attachments to query content URLs.
-     */
-    attachTemporaryUrlsFor(contentSet: Media[] | null): Promise<Media[]>;
     /**
      * Get content URLs for all media attachments in the given set using a single operation.
      * @param contentSet Set of media attachments to query content URLs.
@@ -1060,6 +1012,7 @@ interface MessageResponse {
     media: {
         sid: string;
         size: string;
+        category: string;
         content_type: string;
         filename: string;
     }[] | null;
@@ -1129,7 +1082,7 @@ declare class Messages extends ReplayEventEmitter<MessagesEvents> {
      */
     getMessages(pageSize: number | undefined, anchor: number | "end" | undefined, direction?: "forward" | "backwards"): Promise<SyncPaginator<Message>>;
     private _wrapPaginator;
-    private _upsertMessage;
+    _upsertMessage(index: number, value: MessageData): Message;
     /**
      * Returns last messages from conversation
      * @param {Number} [pageSize] Number of messages to return in single chunk. By default it's 30.
@@ -1629,7 +1582,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * @param attributes Attributes to be attached to the participant.
      * @returns The added participant.
      */
-    add(identity: string, attributes?: JSONValue): Promise<ParticipantResponse>;
+    add(identity: string, attributes?: JSONValue): Promise<Participant>;
     /**
      * Add a non-chat participant to the conversation.
      * @param proxyAddress Proxy (Twilio) address of the participant.
@@ -1639,7 +1592,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * CC/To level.
      * @returns The added participant.
      */
-    addNonChatParticipant(proxyAddress: string, address: string, attributes?: JSONValue, bindingOptions?: ParticipantBindingOptions): Promise<ParticipantResponse>;
+    addNonChatParticipant(proxyAddress: string, address: string, attributes?: JSONValue, bindingOptions?: ParticipantBindingOptions): Promise<Participant>;
     /**
      * Advance the conversation's last read message index to the current read
      * horizon. Rejects if the user is not a participant of the conversation. Last
@@ -1754,7 +1707,7 @@ declare class Conversation extends ReplayEventEmitter<ConversationEvents> {
      * @param emailOptions Email options for the message.
      * @return Index of the new message.
      */
-    sendMessage(message: null | string | FormData | SendMediaOptions, messageAttributes?: JSONValue, emailOptions?: SendEmailOptions): Promise<number>;
+    sendMessage(message: null | string | FormData | SendMediaOptions, messageAttributes?: JSONValue, emailOptions?: SendEmailOptions): Promise<Message>;
     /**
      * New interface to prepare for sending a message.
      * Use this instead of {@link Message.sendMessage}.
@@ -1972,12 +1925,11 @@ type ClientEvents = {
         user: User;
         updateReasons: UserUpdateReason[];
     }) => void;
-    stateChanged: (state: State) => void;
     initialized: () => void;
     initFailed: ({ error }: {
         error?: ConnectionError;
     }) => void;
-    connectionStateChanged: (state: TwilsockConnectionState) => void;
+    connectionStateChanged: (state: ConnectionState) => void;
     connectionError: (data: ConnectionError) => void;
 };
 /**
@@ -1990,7 +1942,7 @@ type ClientEvents = {
  * * `'denied'` - client connection is denied because of invalid JWT access
  * token. User must refresh token in order to proceed
  */
-type ConnectionState = TwilsockConnectionState;
+type ConnectionState = "disconnected" | "connecting" | "connected";
 /**
  * State of the client. Possible values are as follows:
  * * `'failed'` - the client failed to initialize
@@ -2018,7 +1970,7 @@ interface ClientOptions {
     region?: string;
     productId?: string;
     twilsockClient?: TwilsockClient;
-    transport?: Transport;
+    transport?: TwilsockClient;
     notificationsClient?: NotificationClient;
     syncClient?: SyncClient;
     typingIndicatorTimeoutOverride?: number;
@@ -2233,15 +2185,6 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * @event
      */
     static readonly userUpdated = "userUpdated";
-    /**
-     * @deprecated Use initialized or initFailed events instead
-     * Fired when the state of the client has been changed.
-     *
-     * Parameters:
-     * 1. {@link State} `state` - the new client state
-     * @event
-     */
-    static readonly stateChanged = "stateChanged";
     /**
      * Fired when the client has completed initialization successfully.
      * @event
@@ -2301,7 +2244,7 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
     /**
      * Client connection state.
      */
-    connectionState: ConnectionState;
+    connectionState: ConnectionState | "unknown";
     /**
      * Promise that resolves on successful initialization.
      */
@@ -2365,32 +2308,6 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * initialization was completed.
      */
     get reachabilityEnabled(): boolean;
-    /**
-     * @deprecated
-     * Current token.
-     * @internal
-     */
-    get token(): string;
-    /**
-     * @deprecated Call constructor directly.
-     *
-     * Factory method to create a Conversations client instance.
-     *
-     * The factory method will automatically trigger connection.
-     * Do not use it if you need finer-grained control.
-     *
-     * Since this method returns an already-initialized client, some of the events
-     * will be lost because they happen *before* the initialization. It is
-     * recommended that `client.onWithReplay` is used as opposed to `client.on`
-     * for subscribing to client events. The `client.onWithReplay` will re-emit
-     * the most recent value for a given event if it emitted before the
-     * subscription.
-     *
-     * @param token Access token.
-     * @param options Options to customize the client.
-     * @returns Returns a fully initialized client.
-     */
-    static create(token: string, options?: ClientOptions | null): Promise<Client>;
     /**
      * Static method for push notification payload parsing. Returns parsed push as
      * a {@link PushNotification} object.
@@ -2426,7 +2343,7 @@ declare class Client extends ReplayEventEmitter<ClientEvents> {
      * @param conversationSid Conversation sid
      * @internal
      */
-    peekConversationBySid(conversationSid: string): Promise<Conversation>;
+    private peekConversationBySid;
     /**
      * Get a known conversation by its unique identifier name.
      * @param uniqueName The unique identifier name of the conversation.
@@ -2526,4 +2443,5 @@ declare class NotificationTypes {
     static readonly REMOVED_FROM_CONVERSATION = "twilio.conversations.removed_from_conversation";
     static readonly CONSUMPTION_UPDATE = "twilio.channel.consumption_update";
 }
-export { Conversation, ConversationBindings, ConversationEmailBinding, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, ParticipantBindings, ParticipantEmailBinding, ParticipantEmailLevel, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, ParticipantBindingOptions, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions, ConversationLimits, JSONValue, JSONObject, JSONArray, CancellablePromise };
+export { Conversation, ConversationBindings, ConversationEmailBinding, ConversationUpdateReason, ConversationStatus, NotificationLevel, ConversationState, ConversationUpdatedEventArgs, SendMediaOptions, SendEmailOptions, LastMessage, Participant, ParticipantUpdateReason, ParticipantType, ParticipantUpdatedEventArgs, ParticipantBindings, ParticipantEmailBinding, ParticipantEmailLevel, Message, MessageUpdateReason, MessageType, MessageUpdatedEventArgs, Media, MediaCategory$0 as MediaCategory, AggregatedDeliveryReceipt, DeliveryAmount, DetailedDeliveryReceipt, DeliveryStatus, RestPaginator, MessageBuilder, UnsentMessage, Paginator, ParticipantBindingOptions, User, UserUpdateReason, UserUpdatedEventArgs, PushNotification, PushNotificationType, PushNotificationDescriptor, PushNotificationData, NotificationTypes, Client, State, ConnectionState, NotificationsChannelType, ClientOptions, CreateConversationOptions, ConversationLimits, CancellablePromise };
+export { JSONValue, JSONObject, JSONArray } from "@twilio/shared";