@deepdesk/deepdesk-sdk 11.1.0 → 11.1.1-beta.0

package/dist/index.d.mts

@@ -333,6 +333,7 @@ interface APIVersionInit {
     version?: 'v1' | 'v2' | null;
 }
 interface ExtendedRequestInit extends RequestInit, RefreshTokenInit, RetryInit, APIVersionInit {
+    useCache?: boolean;
 }
 declare class HTTPClient {
     baseUrl: string;
@@ -823,6 +824,14 @@ declare namespace Server {
             };
         };
     };
+    /**
+     * API object for account
+     */
+    type Account = {
+        code: string;
+        name: string;
+        rule_engine: boolean;
+    };
     /**
      * API object for free suggestion
      */
@@ -1073,6 +1082,18 @@ declare namespace Server {
         files: Array<string>;
         has_changes: boolean;
     };
+    type Rule = {
+        id: number;
+        profile: string | null;
+        api_endpoint: string | null;
+        name: string;
+        description: string;
+        cue_title: string;
+        cue_text: string;
+        repeat: boolean;
+        is_enabled: boolean;
+        label: string;
+    };
 }
 type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'tags'>> & {
     tags: Record<string, string> | null;
@@ -1180,6 +1201,7 @@ declare class DeepdeskAPI {
     getProfile(profileCode: string): Promise<CamelCaseKeys<Server.Profile>>;
     getKnowledgeAssistant(code: string): Promise<CamelCaseKeys<Server.KnowledgeAssistant>>;
     getContentTypes(): Promise<CamelCaseKeys<Server.ContentType[]>>;
+    getAccount(): Promise<CamelCaseKeys<Server.Account>>;
     getPlatformConfig(): Promise<CamelCaseKeys<Server.PlatformConfig['config']>>;
     checkUserExists(externalId: string): Promise<boolean>;
     getConversationBySessionId(sessionId: string, options?: RetryOptions): Promise<CamelCaseKeys<Server.Conversation>>;
@@ -1276,6 +1298,7 @@ declare class DeepdeskAPI {
     evaluateRule<Payload = unknown>(label: string, conversationId: string, payload: Payload, opts?: {
         raiseForFailingConditions?: boolean;
     }): Promise<CamelCaseKeys<Server.Cue[]>>;
+    getRules(): Promise<CamelCaseKeys<Server.Rule[]>>;
     translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
     private handleDeepdeskVersionHeaders;
 }
@@ -2207,6 +2230,9 @@ type PlatformConfig = {
         };
     };
 };
+/**
+ * @deprecated Use DeepdeskAPI.getPlatformConfig() in stead.
+ */
 declare function fetchPlatformConfig(accountOrigin: string): Promise<PlatformConfig>;
 
 declare function escapeHTML(text: string): string;

package/dist/index.d.ts

@@ -333,6 +333,7 @@ interface APIVersionInit {
     version?: 'v1' | 'v2' | null;
 }
 interface ExtendedRequestInit extends RequestInit, RefreshTokenInit, RetryInit, APIVersionInit {
+    useCache?: boolean;
 }
 declare class HTTPClient {
     baseUrl: string;
@@ -823,6 +824,14 @@ declare namespace Server {
             };
         };
     };
+    /**
+     * API object for account
+     */
+    type Account = {
+        code: string;
+        name: string;
+        rule_engine: boolean;
+    };
     /**
      * API object for free suggestion
      */
@@ -1073,6 +1082,18 @@ declare namespace Server {
         files: Array<string>;
         has_changes: boolean;
     };
+    type Rule = {
+        id: number;
+        profile: string | null;
+        api_endpoint: string | null;
+        name: string;
+        description: string;
+        cue_title: string;
+        cue_text: string;
+        repeat: boolean;
+        is_enabled: boolean;
+        label: string;
+    };
 }
 type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'tags'>> & {
     tags: Record<string, string> | null;
@@ -1180,6 +1201,7 @@ declare class DeepdeskAPI {
     getProfile(profileCode: string): Promise<CamelCaseKeys<Server.Profile>>;
     getKnowledgeAssistant(code: string): Promise<CamelCaseKeys<Server.KnowledgeAssistant>>;
     getContentTypes(): Promise<CamelCaseKeys<Server.ContentType[]>>;
+    getAccount(): Promise<CamelCaseKeys<Server.Account>>;
     getPlatformConfig(): Promise<CamelCaseKeys<Server.PlatformConfig['config']>>;
     checkUserExists(externalId: string): Promise<boolean>;
     getConversationBySessionId(sessionId: string, options?: RetryOptions): Promise<CamelCaseKeys<Server.Conversation>>;
@@ -1276,6 +1298,7 @@ declare class DeepdeskAPI {
     evaluateRule<Payload = unknown>(label: string, conversationId: string, payload: Payload, opts?: {
         raiseForFailingConditions?: boolean;
     }): Promise<CamelCaseKeys<Server.Cue[]>>;
+    getRules(): Promise<CamelCaseKeys<Server.Rule[]>>;
     translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
     private handleDeepdeskVersionHeaders;
 }
@@ -2207,6 +2230,9 @@ type PlatformConfig = {
         };
     };
 };
+/**
+ * @deprecated Use DeepdeskAPI.getPlatformConfig() in stead.
+ */
 declare function fetchPlatformConfig(accountOrigin: string): Promise<PlatformConfig>;
 
 declare function escapeHTML(text: string): string;