@livechat/customer-sdk 3.1.1 → 3.1.2

package/types/types/frames.d.ts

@@ -0,0 +1,635 @@
+import { Any } from 'ts-toolbelt';
+import * as serverDisconnectionReasons from '../constants/serverDisconnectionReasons';
+import * as serverPushActions from '../constants/serverPushActions';
+import * as serverRequestActions from '../constants/serverRequestActions';
+import * as serverEntities from './serverEntities';
+import { SortOrder, SubscribablePush } from '.';
+type EmptyObj = Record<string, never>;
+type Values<T> = T[keyof T];
+export type ChatDeactivatedPush = {
+    action: typeof serverPushActions.CHAT_DEACTIVATED;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        user_id: string;
+    };
+};
+export type ChatPropertiesDeletedPush = {
+    action: typeof serverPushActions.CHAT_PROPERTIES_DELETED;
+    payload: {
+        chat_id: string;
+        properties: Record<string, string[]>;
+    };
+};
+export type ChatPropertiesUpdatedPush = {
+    action: typeof serverPushActions.CHAT_PROPERTIES_UPDATED;
+    payload: {
+        chat_id: string;
+        properties: serverEntities.Properties;
+    };
+};
+type BaseTransferPayload = {
+    chat_id: string;
+    thread_id: string;
+    transferred_to: {
+        group_ids?: number[];
+        agent_ids?: number[];
+    };
+    queue?: serverEntities.Queue;
+};
+type ManualTransferPayload = BaseTransferPayload & {
+    reason: 'manual';
+    requester_id?: string;
+};
+type AutoTransferPayload = BaseTransferPayload & {
+    reason: 'routing.inactive' | 'routing.assigned';
+    requester_id?: never;
+};
+export type ChatTransferredPush = {
+    action: typeof serverPushActions.CHAT_TRANSFERRED;
+    payload: ManualTransferPayload | AutoTransferPayload;
+};
+export type CustomerDisconnectedPush = {
+    action: typeof serverPushActions.CUSTOMER_DISCONNECTED;
+    payload: {
+        reason: Values<typeof serverDisconnectionReasons>;
+        data?: any;
+    };
+};
+export type CustomerPageUpdatedPush = {
+    action: typeof serverPushActions.CUSTOMER_PAGE_UPDATED;
+    payload: {
+        url: string;
+        title?: string;
+        opened_at: string;
+    };
+};
+export type CustomerSideStorageUpdatedPush = {
+    action: typeof serverPushActions.CUSTOMER_SIDE_STORAGE_UPDATED;
+    payload: {
+        customer_side_storage: serverEntities.SideStorage;
+    };
+};
+export type CustomerUpdatedPush = {
+    action: typeof serverPushActions.CUSTOMER_UPDATED;
+    payload: Any.Compute<{
+        id: string;
+    } & serverEntities.OptionalCustomerProps>;
+};
+export type EventPropertiesDeletedPush = {
+    action: typeof serverPushActions.EVENT_PROPERTIES_DELETED;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        event_id: string;
+        properties: Record<string, string[]>;
+    };
+};
+export type EventPropertiesUpdatedPush = {
+    action: typeof serverPushActions.EVENT_PROPERTIES_UPDATED;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        event_id: string;
+        properties: serverEntities.Properties;
+    };
+};
+export type EventUpdatedPush = {
+    action: typeof serverPushActions.EVENT_UPDATED;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        event: serverEntities.Event;
+    };
+};
+export type EventsMarkedAsSeenPush = {
+    action: typeof serverPushActions.EVENTS_MARKED_AS_SEEN;
+    payload: {
+        user_id: string;
+        chat_id: string;
+        seen_up_to: string;
+    };
+};
+export type GreetingAcceptedPush = {
+    action: typeof serverPushActions.GREETING_ACCEPTED;
+    payload: {
+        unique_id: string;
+    };
+};
+export type GreetingCanceledPush = {
+    action: typeof serverPushActions.GREETING_CANCELED;
+    payload: {
+        unique_id: string;
+    };
+};
+export type IncomingChatPush = {
+    action: typeof serverPushActions.INCOMING_CHAT;
+    payload: {
+        chat: serverEntities.IncomingChat;
+    };
+};
+export type IncomingEventPush = {
+    action: typeof serverPushActions.INCOMING_EVENT;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        event: serverEntities.Event;
+    };
+};
+export type IncomingGreetingPush = {
+    action: typeof serverPushActions.INCOMING_GREETING;
+    payload: serverEntities.Greeting;
+};
+export type IncomingMulticastPush = {
+    action: typeof serverPushActions.INCOMING_MULTICAST;
+    payload: {
+        type?: string;
+        content: any;
+    };
+};
+export type IncomingRichMessagePostbackPush = {
+    action: typeof serverPushActions.INCOMING_RICH_MESSAGE_POSTBACK;
+    payload: {
+        user_id: string;
+        chat_id: string;
+        thread_id: string;
+        event_id: string;
+        postback: {
+            id: string;
+            toggled: boolean;
+        };
+    };
+};
+export type IncomingTypingIndicatorPush = {
+    action: typeof serverPushActions.INCOMING_TYPING_INDICATOR;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        typing_indicator: {
+            author_id: string;
+            timestamp: number;
+            is_typing: boolean;
+        };
+    };
+};
+export type QueuePositionUpdatedPush = {
+    action: typeof serverPushActions.QUEUE_POSITION_UPDATED;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        queue: serverEntities.QueueUpdate;
+    };
+};
+export type ThreadPropertiesDeletedPush = {
+    action: typeof serverPushActions.THREAD_PROPERTIES_DELETED;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        properties: Record<string, string[]>;
+    };
+};
+export type ThreadPropertiesUpdatedPush = {
+    action: typeof serverPushActions.THREAD_PROPERTIES_UPDATED;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        properties: serverEntities.Properties;
+    };
+};
+export type UserAddedToChatPush = {
+    action: typeof serverPushActions.USER_ADDED_TO_CHAT;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        user: serverEntities.ChatUser;
+    };
+};
+export type UserRemovedFromChatPush = {
+    action: typeof serverPushActions.USER_REMOVED_FROM_CHAT;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        user_id: string;
+    };
+};
+export type PushResponse = Any.Compute<{
+    type: 'push';
+    request_id: string;
+} & (ChatDeactivatedPush | IncomingChatPush | IncomingEventPush)>;
+export type Push = Any.Compute<{
+    type: 'push';
+} & (ChatDeactivatedPush | ChatPropertiesDeletedPush | ChatPropertiesUpdatedPush | ChatTransferredPush | CustomerDisconnectedPush | CustomerPageUpdatedPush | CustomerSideStorageUpdatedPush | CustomerUpdatedPush | EventPropertiesDeletedPush | EventPropertiesUpdatedPush | EventUpdatedPush | EventsMarkedAsSeenPush | GreetingAcceptedPush | GreetingCanceledPush | IncomingChatPush | IncomingEventPush | IncomingMulticastPush | IncomingGreetingPush | IncomingRichMessagePostbackPush | IncomingTypingIndicatorPush | QueuePositionUpdatedPush | ThreadPropertiesDeletedPush | ThreadPropertiesUpdatedPush | UserAddedToChatPush | UserRemovedFromChatPush)>;
+export type AcceptGreetingRequest = {
+    action: typeof serverRequestActions.ACCEPT_GREETING;
+    payload: {
+        greeting_id: number;
+        unique_id: string;
+    };
+};
+export type CancelGreetingRequest = {
+    action: typeof serverRequestActions.CANCEL_GREETING;
+    payload: {
+        unique_id: string;
+    };
+};
+export type DeactivateChatRequest = {
+    action: typeof serverRequestActions.DEACTIVATE_CHAT;
+    payload: {
+        id: string;
+    };
+};
+export type DeleteChatPropertiesRequest = {
+    action: typeof serverRequestActions.DELETE_CHAT_PROPERTIES;
+    payload: {
+        id: string;
+        properties: Record<string, string[]>;
+    };
+};
+export type DeleteEventPropertiesRequest = {
+    action: typeof serverRequestActions.DELETE_EVENT_PROPERTIES;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        event_id: string;
+        properties: Record<string, string[]>;
+    };
+};
+export type DeleteThreadPropertiesRequest = {
+    action: typeof serverRequestActions.DELETE_THREAD_PROPERTIES;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        properties: Record<string, string[]>;
+    };
+};
+export type GetChatRequest = {
+    action: typeof serverRequestActions.GET_CHAT;
+    payload: {
+        chat_id: string;
+        thread_id?: string;
+    };
+};
+export type GetCustomerRequest = {
+    action: typeof serverRequestActions.GET_CUSTOMER;
+    payload: EmptyObj;
+};
+export type GetFormRequest = {
+    action: typeof serverRequestActions.GET_FORM;
+    payload: {
+        type: serverEntities.FormType;
+        group_id: number;
+    };
+};
+export type GetPredictedAgentRequest = {
+    action: typeof serverRequestActions.GET_PREDICTED_AGENT;
+    payload: {
+        group_id?: number;
+    };
+};
+export type GetUrlInfoRequest = {
+    action: typeof serverRequestActions.GET_URL_INFO;
+    payload: {
+        url: string;
+    };
+};
+export type ListChatsRequest = {
+    action: typeof serverRequestActions.LIST_CHATS;
+    payload: {
+        limit?: number;
+        page_id?: string;
+    };
+};
+export type ListGroupStatusesRequest = {
+    action: typeof serverRequestActions.LIST_GROUP_STATUSES;
+    payload: {
+        group_ids: number[];
+    } | {
+        all: true;
+    };
+};
+export type ListThreadsRequest = {
+    action: typeof serverRequestActions.LIST_THREADS;
+    payload: {
+        chat_id: string;
+        sort_order?: SortOrder;
+        limit?: number;
+        page_id?: string;
+        min_events_count?: number;
+    };
+};
+export type LoginRequest = {
+    action: typeof serverRequestActions.LOGIN;
+    payload: {
+        token: string;
+        customer?: {
+            avatar?: string;
+            email?: string;
+            name?: string;
+            fields?: serverEntities.CustomerSessionFields;
+        };
+        customer_page?: {
+            url?: string;
+            title?: string;
+        };
+        customer_side_storage?: serverEntities.SideStorage;
+        is_mobile?: boolean;
+        group_id?: number;
+        referrer?: string;
+        pushes?: Record<string, ReadonlyArray<SubscribablePush>>;
+    };
+};
+export type MarkEventsAsSeenRequest = {
+    action: typeof serverRequestActions.MARK_EVENTS_AS_SEEN;
+    payload: {
+        chat_id: string;
+        seen_up_to: string;
+    };
+};
+export type ResumeChatRequest = {
+    action: typeof serverRequestActions.RESUME_CHAT;
+    payload: {
+        active?: boolean;
+        chat: {
+            id: string;
+            access?: serverEntities.Access;
+            properties?: serverEntities.Properties;
+            thread?: {
+                events?: serverEntities.RequestBodyEvent[];
+                properties?: serverEntities.Properties;
+            };
+        };
+        continuous?: boolean;
+    };
+};
+export type SendEventRequest = {
+    action: typeof serverRequestActions.SEND_EVENT;
+    payload: {
+        chat_id: string;
+        event: serverEntities.RequestBodyEvent;
+        attach_to_last_thread?: boolean;
+    };
+};
+export type SendRichMessagePostbackRequest = {
+    action: typeof serverRequestActions.SEND_RICH_MESSAGE_POSTBACK;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        event_id: string;
+        postback: {
+            id: string;
+            toggled: boolean;
+        };
+    };
+};
+export type SendSneakPeekRequest = {
+    action: typeof serverRequestActions.SEND_SNEAK_PEEK;
+    payload: {
+        chat_id: string;
+        sneak_peek_text: string;
+    };
+};
+export type SetCustomerSessionFieldsRequest = {
+    action: typeof serverRequestActions.SET_CUSTOMER_SESSION_FIELDS;
+    payload: {
+        session_fields: serverEntities.CustomerSessionFields;
+    };
+};
+export type StartChatRequest = {
+    action: typeof serverRequestActions.START_CHAT;
+    payload: {
+        active?: boolean;
+        chat?: {
+            access?: serverEntities.Access;
+            properties?: serverEntities.Properties;
+            thread?: {
+                events?: serverEntities.RequestBodyEvent[];
+                properties?: serverEntities.Properties;
+            };
+        };
+        continuous?: boolean;
+    };
+};
+export type UpdateChatPropertiesRequest = {
+    action: typeof serverRequestActions.UPDATE_CHAT_PROPERTIES;
+    payload: {
+        id: string;
+        properties: serverEntities.Properties;
+    };
+};
+export type UpdateCustomerPageRequest = {
+    action: typeof serverRequestActions.UPDATE_CUSTOMER_PAGE;
+    payload: {
+        url: string;
+        title?: string;
+    };
+};
+export type UpdateCustomerRequest = {
+    action: typeof serverRequestActions.UPDATE_CUSTOMER;
+    payload: {
+        avatar?: string;
+        name?: string;
+        email?: string;
+        fields?: serverEntities.CustomerSessionFields;
+    };
+};
+export type UpdateEventPropertiesRequest = {
+    action: typeof serverRequestActions.UPDATE_EVENT_PROPERTIES;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        event_id: string;
+        properties: serverEntities.Properties;
+    };
+};
+export type UpdateThreadPropertiesRequest = {
+    action: typeof serverRequestActions.UPDATE_THREAD_PROPERTIES;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+        properties: serverEntities.Properties;
+    };
+};
+export type Request = Any.Compute<{
+    request_id: string;
+    version?: string;
+} & (AcceptGreetingRequest | CancelGreetingRequest | DeactivateChatRequest | DeleteChatPropertiesRequest | DeleteEventPropertiesRequest | DeleteThreadPropertiesRequest | GetChatRequest | GetCustomerRequest | GetFormRequest | GetPredictedAgentRequest | GetUrlInfoRequest | ListGroupStatusesRequest | ListChatsRequest | ListThreadsRequest | LoginRequest | MarkEventsAsSeenRequest | ResumeChatRequest | SendEventRequest | SendRichMessagePostbackRequest | SendSneakPeekRequest | SetCustomerSessionFieldsRequest | StartChatRequest | UpdateChatPropertiesRequest | UpdateCustomerPageRequest | UpdateCustomerRequest | UpdateEventPropertiesRequest | UpdateThreadPropertiesRequest)>;
+export type AcceptGreetingResponse = {
+    action: typeof serverRequestActions.ACCEPT_GREETING;
+    payload: EmptyObj;
+};
+export type CancelGreetingResponse = {
+    action: typeof serverRequestActions.CANCEL_GREETING;
+    payload: EmptyObj;
+};
+export type DeactivateChatResponse = {
+    action: typeof serverRequestActions.DEACTIVATE_CHAT;
+    payload: EmptyObj;
+};
+export type DeleteChatPropertiesResponse = {
+    action: typeof serverRequestActions.DELETE_CHAT_PROPERTIES;
+    payload: EmptyObj;
+};
+export type DeleteEventPropertiesResponse = {
+    action: typeof serverRequestActions.DELETE_EVENT_PROPERTIES;
+    payload: EmptyObj;
+};
+export type DeleteThreadPropertiesResponse = {
+    action: typeof serverRequestActions.DELETE_THREAD_PROPERTIES;
+    payload: EmptyObj;
+};
+export type GetChatResponse = {
+    action: typeof serverRequestActions.GET_CHAT;
+    payload: serverEntities.Chat;
+};
+export type GetCustomerResponse = {
+    action: typeof serverRequestActions.GET_CUSTOMER;
+    payload: serverEntities.Customer;
+};
+export type GetFormResponse = {
+    action: typeof serverRequestActions.GET_FORM;
+    payload: {
+        enabled: true;
+        form: {
+            id: string;
+            fields: serverEntities.FormField[];
+        };
+    } | {
+        enabled: false;
+    };
+};
+export type GetPredictedAgentResponse = {
+    action: typeof serverRequestActions.GET_PREDICTED_AGENT;
+    payload: {
+        agent: serverEntities.PredictedAgent;
+        queue: boolean;
+    };
+};
+export type GetUrlInfoResponse = {
+    action: typeof serverRequestActions.GET_URL_INFO;
+    payload: {
+        url: string;
+        title?: string;
+        description?: string;
+        image_url?: string;
+        image_width?: number;
+        image_height?: number;
+    };
+};
+export type ListChatsResponse = {
+    action: typeof serverRequestActions.LIST_CHATS;
+    payload: {
+        chats_summary: serverEntities.ChatSummary[];
+        total_chats: number;
+        previous_page_id?: string;
+        next_page_id?: string;
+    };
+};
+export type ListGroupStatusesResponse = {
+    action: typeof serverRequestActions.LIST_GROUP_STATUSES;
+    payload: {
+        groups_status: Record<number, serverEntities.GroupStatus>;
+    };
+};
+export type ListThreadsResponse = {
+    action: typeof serverRequestActions.LIST_THREADS;
+    payload: {
+        threads: serverEntities.Thread[];
+        previous_page_id?: string;
+        next_page_id?: string;
+    };
+};
+export type LoginResponse = {
+    action: typeof serverRequestActions.LOGIN;
+    payload: {
+        customer_id: string;
+        customer: serverEntities.Customer;
+        has_active_thread: boolean;
+        chats: Array<{
+            chat_id: string;
+            has_unread_events: boolean;
+            has_active_thread?: boolean;
+        }>;
+        __priv_dynamic_config: serverEntities.DynamicConfig;
+        greeting?: serverEntities.Greeting;
+    };
+};
+export type MarkEventsAsSeenResponse = {
+    action: typeof serverRequestActions.MARK_EVENTS_AS_SEEN;
+    payload: EmptyObj;
+};
+export type ResumeChatResponse = {
+    action: typeof serverRequestActions.RESUME_CHAT;
+    payload: {
+        thread_id: string;
+    };
+};
+export type SendEventResponse = {
+    action: typeof serverRequestActions.SEND_EVENT;
+    payload: {
+        event_id: string;
+    };
+};
+export type SendRichMessagePostbackResponse = {
+    action: typeof serverRequestActions.SEND_RICH_MESSAGE_POSTBACK;
+    payload: EmptyObj;
+};
+export type SendSneakPeekResponse = {
+    action: typeof serverRequestActions.SEND_SNEAK_PEEK;
+    payload: EmptyObj;
+};
+export type SetCustomerSessionFieldsResponse = {
+    action: typeof serverRequestActions.SET_CUSTOMER_SESSION_FIELDS;
+    payload: EmptyObj;
+};
+export type StartChatResponse = {
+    action: typeof serverRequestActions.START_CHAT;
+    payload: {
+        chat_id: string;
+        thread_id: string;
+    };
+};
+export type UpdateChatPropertiesResponse = {
+    action: typeof serverRequestActions.UPDATE_CHAT_PROPERTIES;
+    payload: EmptyObj;
+};
+export type UpdateCustomerPageResponse = {
+    action: typeof serverRequestActions.UPDATE_CUSTOMER_PAGE;
+    payload: EmptyObj;
+};
+export type UpdateCustomerResponse = {
+    action: typeof serverRequestActions.UPDATE_CUSTOMER;
+    payload: EmptyObj;
+};
+export type UpdateEventPropertiesResponse = {
+    action: typeof serverRequestActions.UPDATE_EVENT_PROPERTIES;
+    payload: EmptyObj;
+};
+export type UpdateThreadPropertiesResponse = {
+    action: typeof serverRequestActions.UPDATE_THREAD_PROPERTIES;
+    payload: EmptyObj;
+};
+export type Response = Any.Compute<{
+    type: 'response';
+    request_id: string;
+    success: true;
+} & (AcceptGreetingResponse | CancelGreetingResponse | DeleteChatPropertiesResponse | DeleteEventPropertiesResponse | DeleteThreadPropertiesResponse | GetChatResponse | GetCustomerResponse | GetFormResponse | GetPredictedAgentResponse | GetUrlInfoResponse | ListChatsResponse | ListGroupStatusesResponse | ListThreadsResponse | LoginResponse | MarkEventsAsSeenResponse | ResumeChatResponse | SendEventResponse | SendRichMessagePostbackResponse | SendSneakPeekResponse | SetCustomerSessionFieldsResponse | StartChatResponse | UpdateChatPropertiesResponse | UpdateCustomerPageResponse | UpdateCustomerResponse | UpdateEventPropertiesResponse | UpdateThreadPropertiesResponse)>;
+export type DirectResponse = Exclude<Response, {
+    action: typeof serverRequestActions.RESUME_CHAT | typeof serverRequestActions.SEND_EVENT | typeof serverRequestActions.START_CHAT;
+}>;
+export type ResponseError = {
+    request_id: string;
+    action: string;
+    type: 'response';
+    success: false;
+    payload: {
+        error: {
+            type: string;
+            message: string;
+            data?: {
+                [key: string]: string;
+            };
+        };
+    };
+};
+export {};
+//# sourceMappingURL=frames.d.ts.map