@deepdesk/deepdesk-sdk 16.0.2-beta.2 → 16.0.2-beta.3

package/dist/index.d.mts

@@ -344,13 +344,14 @@ type Profile = CamelCaseKeys<Server.Profile>;
 
 type CreateConversation = {
     platform: string;
-    sessionId: string;
+    externalId: string;
     profileCode?: string;
     agentId: string;
     agentName?: string;
     agentNickname?: string;
     agentEmail?: string;
-    tags?: Record<string, string> | null;
+    metadata?: Server.Metadata;
+    chatStartTime?: string;
 };
 type TranslationRequest = {
     targetLanguage: string;
@@ -441,18 +442,23 @@ declare class HTTPClient {
 }
 
 declare namespace Server {
+    /**
+     * Metadata
+     */
+    type Metadata = Record<string, string>;
     /**
      * API create conversation payload
      */
     type CreateConversationPayload = {
         platform: string;
-        session_id: string;
+        external_id: string;
         agent_id: string;
         profile_code?: string;
-        tags?: Record<string, string> | null;
+        metadata: Metadata;
         agent_name?: string;
         agent_nickname?: string;
         agent_email?: string;
+        chat_start_time?: string;
     };
     /**
      * API message object
@@ -465,7 +471,7 @@ declare namespace Server {
         author_name?: string;
         author_email?: string;
         text: string;
-        tags: Record<string, string> | null;
+        metadata: Metadata;
     };
     /**
      * API conversation object
@@ -473,7 +479,6 @@ declare namespace Server {
     type Conversation = {
         id: string;
         profile_code: string | null;
-        channel: string | null;
         platform: string;
         agent_id: string;
         agent_name: string | null;
@@ -484,30 +489,12 @@ declare namespace Server {
         engagement_id: string | null;
         engagement_name: string | null;
         engagement_skill: string | null;
-        agent_note: string | null;
-        survey_email: string | null;
-        survey_name: string | null;
-        survey_phone: string | null;
         visitor_id: string | null;
         visitor_name: string | null;
-        visitor_device: string | null;
-        visitor_browser: string | null;
-        visitor_os: string | null;
-        visitor_country: string | null;
-        visitor_state: string | null;
-        visitor_city: string | null;
-        visitor_isp: string | null;
-        visitor_organization: string | null;
-        visitor_ip_address: string | null;
-        chat_start_time: number | null;
-        session_start_time: number | null;
-        visit_start_time: string | null;
-        session_id: string;
+        chat_start_time: string | null;
+        external_id: string;
         messages: ConversationMessage[];
-        tags: Record<string, string> | null;
-        has_active_profile: boolean;
-        created: string;
-        updated: string;
+        metadata: Metadata;
     };
     /**
      * API object for url suggestion
@@ -882,11 +869,11 @@ declare namespace Server {
         };
     };
 }
-type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'tags'>> & {
-    tags: Record<string, string> | null;
+type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'metadata'>> & {
+    metadata: Server.Metadata;
 };
-type Conversation = CamelCaseKeys<Omit<Server.Conversation, 'tags' | 'messages'>> & {
-    tags: Record<string, string> | null;
+type Conversation = CamelCaseKeys<Omit<Server.Conversation, 'metadata' | 'messages'>> & {
+    metadata: Server.Metadata;
 } & {
     messages: ConversationMessage[];
 };
@@ -894,10 +881,14 @@ type Conversation = CamelCaseKeys<Omit<Server.Conversation, 'tags' | 'messages'>
  * Create Conversation Options
  */
 type CreateConversationOptions = {
+    /**
+     * Chat start time
+     */
+    chatStartTime?: string;
     /**
      * The platform's conversation ID.
      */
-    sessionId: string;
+    externalId: string;
     /**
      * The agent ID
      */
@@ -910,7 +901,7 @@ type CreateConversationOptions = {
      * The client profile code, e.g. 'b2b' or 'b2c'
      */
     profileCode?: string;
-    tags?: Record<string, string> | null;
+    metadata: Server.Metadata;
     agentName?: string;
     agentNickname?: string;
     agentEmail?: string;
@@ -1082,12 +1073,12 @@ declare class DeepdeskAPI {
      */
     getPlatformConfig(platformConfigId?: number): Promise<CamelCaseKeys<Server.PlatformConfig['config']>>;
     checkUserExists(externalId: string): Promise<boolean>;
-    getConversationBySessionId(sessionId: string, options?: RetryOptions): Promise<CamelCaseKeys<Server.Conversation>>;
-    isConversationSupported(sessionId: string, options?: RetryOptions): Promise<boolean>;
+    getConversationByExternalId(externalId: string, options?: RetryOptions): Promise<CamelCaseKeys<Server.Conversation>>;
+    isConversationSupported(externalId: string, options?: RetryOptions): Promise<boolean>;
     /**
      * Update converstation meta data
      */
-    updateConversation(conversationId: string, data: Partial<Conversation>): Promise<Conversation>;
+    updateConversation(conversationId: string, data: Partial<Omit<Conversation, 'messages'>>): Promise<Conversation>;
     /**
      * Post converstation messages
      */
@@ -1100,7 +1091,7 @@ declare class DeepdeskAPI {
         authorName?: string | undefined;
         authorEmail?: string | undefined;
     } & {
-        tags: Record<string, string> | null;
+        metadata: Server.Metadata;
     })[]>;
     /**
      * Send event with meta data for analytics
@@ -1138,7 +1129,7 @@ declare class DeepdeskAPI {
     /**
      * Request pinned messages
      */
-    getPinnedMessages(conversationId: string): Promise<CamelCaseKeys<Server.PinnedMessage[]>>;
+    getPinnedMessages(profileCode: string): Promise<TextSuggestion[]>;
     /**
      * Request style suggestions
      */
@@ -2184,17 +2175,17 @@ declare class DeepdeskSDK {
     get selectedTextSuggestion(): TextSuggestion;
     hasConversation(): boolean;
     conversationId(): string;
-    private sessionId;
+    private externalId;
     private shouldAbort;
     login(): Promise<void>;
     isLoggedIn(): Promise<boolean>;
     /**
      * Check if conversation is supported by Deepdesk
-     * @param sessionId - A string with the conversation session ID.
-     *  A session ID is local to the customer service platform, and identifies a
+     * @param externalId - A string with the conversation external ID.
+     *  A external ID is local to the customer service platform, and identifies a
      *  conversation that takes place within a certain time frame.
      */
-    isConversationSupported(sessionId: string, options?: Parameters<typeof DeepdeskAPI.prototype.isConversationSupported>[1]): Promise<boolean>;
+    isConversationSupported(externalId: string, options?: Parameters<typeof DeepdeskAPI.prototype.isConversationSupported>[1]): Promise<boolean>;
     /**
      * Create a conversation
      * This should only be used when backend ingestion (via webhooks) is not possible.
@@ -2203,11 +2194,11 @@ declare class DeepdeskSDK {
     createConversation(data: CreateConversation): Promise<Conversation>;
     /**
      * Get a conversation by session ID
-     * @param sessionId - A string with the conversation session ID.
+     * @param externalId - A string with the conversation session ID.
      *  A session ID is local to the customer service platform, and identifies a
      *  conversation that takes place within a certain time frame.
      */
-    getConversationBySessionId(sessionId: string, options?: Parameters<typeof DeepdeskAPI.prototype.getConversationBySessionId>[1]): Promise<Conversation>;
+    getConversationByExternalId(externalId: string, options?: Parameters<typeof DeepdeskAPI.prototype.getConversationByExternalId>[1]): Promise<Conversation>;
     /**
      * Upsert a conversation: Get and update conversation or create it if it does not exist yet.
      */
@@ -2268,18 +2259,18 @@ declare class DeepdeskSDK {
         expectFormat?: T;
         input?: Record<string, any>;
         transcript?: TranscriptOption;
-        includeTags?: boolean;
+        includeMetadata?: boolean;
         showCuesInWidget?: boolean;
     }): Promise<EvaluationOutput<T> | string>;
     /**
      * Evaluate conversation lifecycle assistant
      * Convenient wrapper around `evaluateAssistant`.
-     * By default includes 'stored-transcript' and 'tags'.
+     * By default includes 'stored-transcript' and 'metadata'.
      */
     evaluateConversationAssistant(event: 'accepted' | 'new-message' | 'ended', options?: {
         input?: Record<string, any>;
         transcript?: TranscriptOption;
-        includeTags?: boolean;
+        includeMetadata?: boolean;
         showCuesInWidget?: boolean;
     }): Promise<void>;
     /**

package/dist/index.d.ts

@@ -344,13 +344,14 @@ type Profile = CamelCaseKeys<Server.Profile>;
 
 type CreateConversation = {
     platform: string;
-    sessionId: string;
+    externalId: string;
     profileCode?: string;
     agentId: string;
     agentName?: string;
     agentNickname?: string;
     agentEmail?: string;
-    tags?: Record<string, string> | null;
+    metadata?: Server.Metadata;
+    chatStartTime?: string;
 };
 type TranslationRequest = {
     targetLanguage: string;
@@ -441,18 +442,23 @@ declare class HTTPClient {
 }
 
 declare namespace Server {
+    /**
+     * Metadata
+     */
+    type Metadata = Record<string, string>;
     /**
      * API create conversation payload
      */
     type CreateConversationPayload = {
         platform: string;
-        session_id: string;
+        external_id: string;
         agent_id: string;
         profile_code?: string;
-        tags?: Record<string, string> | null;
+        metadata: Metadata;
         agent_name?: string;
         agent_nickname?: string;
         agent_email?: string;
+        chat_start_time?: string;
     };
     /**
      * API message object
@@ -465,7 +471,7 @@ declare namespace Server {
         author_name?: string;
         author_email?: string;
         text: string;
-        tags: Record<string, string> | null;
+        metadata: Metadata;
     };
     /**
      * API conversation object
@@ -473,7 +479,6 @@ declare namespace Server {
     type Conversation = {
         id: string;
         profile_code: string | null;
-        channel: string | null;
         platform: string;
         agent_id: string;
         agent_name: string | null;
@@ -484,30 +489,12 @@ declare namespace Server {
         engagement_id: string | null;
         engagement_name: string | null;
         engagement_skill: string | null;
-        agent_note: string | null;
-        survey_email: string | null;
-        survey_name: string | null;
-        survey_phone: string | null;
         visitor_id: string | null;
         visitor_name: string | null;
-        visitor_device: string | null;
-        visitor_browser: string | null;
-        visitor_os: string | null;
-        visitor_country: string | null;
-        visitor_state: string | null;
-        visitor_city: string | null;
-        visitor_isp: string | null;
-        visitor_organization: string | null;
-        visitor_ip_address: string | null;
-        chat_start_time: number | null;
-        session_start_time: number | null;
-        visit_start_time: string | null;
-        session_id: string;
+        chat_start_time: string | null;
+        external_id: string;
         messages: ConversationMessage[];
-        tags: Record<string, string> | null;
-        has_active_profile: boolean;
-        created: string;
-        updated: string;
+        metadata: Metadata;
     };
     /**
      * API object for url suggestion
@@ -882,11 +869,11 @@ declare namespace Server {
         };
     };
 }
-type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'tags'>> & {
-    tags: Record<string, string> | null;
+type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'metadata'>> & {
+    metadata: Server.Metadata;
 };
-type Conversation = CamelCaseKeys<Omit<Server.Conversation, 'tags' | 'messages'>> & {
-    tags: Record<string, string> | null;
+type Conversation = CamelCaseKeys<Omit<Server.Conversation, 'metadata' | 'messages'>> & {
+    metadata: Server.Metadata;
 } & {
     messages: ConversationMessage[];
 };
@@ -894,10 +881,14 @@ type Conversation = CamelCaseKeys<Omit<Server.Conversation, 'tags' | 'messages'>
  * Create Conversation Options
  */
 type CreateConversationOptions = {
+    /**
+     * Chat start time
+     */
+    chatStartTime?: string;
     /**
      * The platform's conversation ID.
      */
-    sessionId: string;
+    externalId: string;
     /**
      * The agent ID
      */
@@ -910,7 +901,7 @@ type CreateConversationOptions = {
      * The client profile code, e.g. 'b2b' or 'b2c'
      */
     profileCode?: string;
-    tags?: Record<string, string> | null;
+    metadata: Server.Metadata;
     agentName?: string;
     agentNickname?: string;
     agentEmail?: string;
@@ -1082,12 +1073,12 @@ declare class DeepdeskAPI {
      */
     getPlatformConfig(platformConfigId?: number): Promise<CamelCaseKeys<Server.PlatformConfig['config']>>;
     checkUserExists(externalId: string): Promise<boolean>;
-    getConversationBySessionId(sessionId: string, options?: RetryOptions): Promise<CamelCaseKeys<Server.Conversation>>;
-    isConversationSupported(sessionId: string, options?: RetryOptions): Promise<boolean>;
+    getConversationByExternalId(externalId: string, options?: RetryOptions): Promise<CamelCaseKeys<Server.Conversation>>;
+    isConversationSupported(externalId: string, options?: RetryOptions): Promise<boolean>;
     /**
      * Update converstation meta data
      */
-    updateConversation(conversationId: string, data: Partial<Conversation>): Promise<Conversation>;
+    updateConversation(conversationId: string, data: Partial<Omit<Conversation, 'messages'>>): Promise<Conversation>;
     /**
      * Post converstation messages
      */
@@ -1100,7 +1091,7 @@ declare class DeepdeskAPI {
         authorName?: string | undefined;
         authorEmail?: string | undefined;
     } & {
-        tags: Record<string, string> | null;
+        metadata: Server.Metadata;
     })[]>;
     /**
      * Send event with meta data for analytics
@@ -1138,7 +1129,7 @@ declare class DeepdeskAPI {
     /**
      * Request pinned messages
      */
-    getPinnedMessages(conversationId: string): Promise<CamelCaseKeys<Server.PinnedMessage[]>>;
+    getPinnedMessages(profileCode: string): Promise<TextSuggestion[]>;
     /**
      * Request style suggestions
      */
@@ -2184,17 +2175,17 @@ declare class DeepdeskSDK {
     get selectedTextSuggestion(): TextSuggestion;
     hasConversation(): boolean;
     conversationId(): string;
-    private sessionId;
+    private externalId;
     private shouldAbort;
     login(): Promise<void>;
     isLoggedIn(): Promise<boolean>;
     /**
      * Check if conversation is supported by Deepdesk
-     * @param sessionId - A string with the conversation session ID.
-     *  A session ID is local to the customer service platform, and identifies a
+     * @param externalId - A string with the conversation external ID.
+     *  A external ID is local to the customer service platform, and identifies a
      *  conversation that takes place within a certain time frame.
      */
-    isConversationSupported(sessionId: string, options?: Parameters<typeof DeepdeskAPI.prototype.isConversationSupported>[1]): Promise<boolean>;
+    isConversationSupported(externalId: string, options?: Parameters<typeof DeepdeskAPI.prototype.isConversationSupported>[1]): Promise<boolean>;
     /**
      * Create a conversation
      * This should only be used when backend ingestion (via webhooks) is not possible.
@@ -2203,11 +2194,11 @@ declare class DeepdeskSDK {
     createConversation(data: CreateConversation): Promise<Conversation>;
     /**
      * Get a conversation by session ID
-     * @param sessionId - A string with the conversation session ID.
+     * @param externalId - A string with the conversation session ID.
      *  A session ID is local to the customer service platform, and identifies a
      *  conversation that takes place within a certain time frame.
      */
-    getConversationBySessionId(sessionId: string, options?: Parameters<typeof DeepdeskAPI.prototype.getConversationBySessionId>[1]): Promise<Conversation>;
+    getConversationByExternalId(externalId: string, options?: Parameters<typeof DeepdeskAPI.prototype.getConversationByExternalId>[1]): Promise<Conversation>;
     /**
      * Upsert a conversation: Get and update conversation or create it if it does not exist yet.
      */
@@ -2268,18 +2259,18 @@ declare class DeepdeskSDK {
         expectFormat?: T;
         input?: Record<string, any>;
         transcript?: TranscriptOption;
-        includeTags?: boolean;
+        includeMetadata?: boolean;
         showCuesInWidget?: boolean;
     }): Promise<EvaluationOutput<T> | string>;
     /**
      * Evaluate conversation lifecycle assistant
      * Convenient wrapper around `evaluateAssistant`.
-     * By default includes 'stored-transcript' and 'tags'.
+     * By default includes 'stored-transcript' and 'metadata'.
      */
     evaluateConversationAssistant(event: 'accepted' | 'new-message' | 'ended', options?: {
         input?: Record<string, any>;
         transcript?: TranscriptOption;
-        includeTags?: boolean;
+        includeMetadata?: boolean;
         showCuesInWidget?: boolean;
     }): Promise<void>;
     /**