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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -333,6 +333,7 @@ interface APIVersionInit {
333
333
  version?: 'v1' | 'v2' | null;
334
334
  }
335
335
  interface ExtendedRequestInit extends RequestInit, RefreshTokenInit, RetryInit, APIVersionInit {
336
+ useCache?: boolean;
336
337
  }
337
338
  declare class HTTPClient {
338
339
  baseUrl: string;
@@ -823,6 +824,15 @@ declare namespace Server {
823
824
  };
824
825
  };
825
826
  };
827
+ /**
828
+ * API object for account
829
+ */
830
+ type Account = {
831
+ code: string;
832
+ name: string;
833
+ rule_engine: boolean;
834
+ live_translation_enabled: boolean;
835
+ };
826
836
  /**
827
837
  * API object for free suggestion
828
838
  */
@@ -1073,6 +1083,18 @@ declare namespace Server {
1073
1083
  files: Array<string>;
1074
1084
  has_changes: boolean;
1075
1085
  };
1086
+ type Rule = {
1087
+ id: number;
1088
+ profile: string | null;
1089
+ api_endpoint: string | null;
1090
+ name: string;
1091
+ description: string;
1092
+ cue_title: string;
1093
+ cue_text: string;
1094
+ repeat: boolean;
1095
+ is_enabled: boolean;
1096
+ label: string;
1097
+ };
1076
1098
  }
1077
1099
  type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'tags'>> & {
1078
1100
  tags: Record<string, string> | null;
@@ -1180,6 +1202,7 @@ declare class DeepdeskAPI {
1180
1202
  getProfile(profileCode: string): Promise<CamelCaseKeys<Server.Profile>>;
1181
1203
  getKnowledgeAssistant(code: string): Promise<CamelCaseKeys<Server.KnowledgeAssistant>>;
1182
1204
  getContentTypes(): Promise<CamelCaseKeys<Server.ContentType[]>>;
1205
+ getAccount(): Promise<CamelCaseKeys<Server.Account>>;
1183
1206
  getPlatformConfig(): Promise<CamelCaseKeys<Server.PlatformConfig['config']>>;
1184
1207
  checkUserExists(externalId: string): Promise<boolean>;
1185
1208
  getConversationBySessionId(sessionId: string, options?: RetryOptions): Promise<CamelCaseKeys<Server.Conversation>>;
@@ -1276,6 +1299,7 @@ declare class DeepdeskAPI {
1276
1299
  evaluateRule<Payload = unknown>(label: string, conversationId: string, payload: Payload, opts?: {
1277
1300
  raiseForFailingConditions?: boolean;
1278
1301
  }): Promise<CamelCaseKeys<Server.Cue[]>>;
1302
+ getRules(): Promise<CamelCaseKeys<Server.Rule[]>>;
1279
1303
  translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
1280
1304
  private handleDeepdeskVersionHeaders;
1281
1305
  }
@@ -2207,6 +2231,9 @@ type PlatformConfig = {
2207
2231
  };
2208
2232
  };
2209
2233
  };
2234
+ /**
2235
+ * @deprecated Use DeepdeskAPI.getPlatformConfig() in stead.
2236
+ */
2210
2237
  declare function fetchPlatformConfig(accountOrigin: string): Promise<PlatformConfig>;
2211
2238
 
2212
2239
  declare function escapeHTML(text: string): string;
package/dist/index.d.ts CHANGED
@@ -333,6 +333,7 @@ interface APIVersionInit {
333
333
  version?: 'v1' | 'v2' | null;
334
334
  }
335
335
  interface ExtendedRequestInit extends RequestInit, RefreshTokenInit, RetryInit, APIVersionInit {
336
+ useCache?: boolean;
336
337
  }
337
338
  declare class HTTPClient {
338
339
  baseUrl: string;
@@ -823,6 +824,15 @@ declare namespace Server {
823
824
  };
824
825
  };
825
826
  };
827
+ /**
828
+ * API object for account
829
+ */
830
+ type Account = {
831
+ code: string;
832
+ name: string;
833
+ rule_engine: boolean;
834
+ live_translation_enabled: boolean;
835
+ };
826
836
  /**
827
837
  * API object for free suggestion
828
838
  */
@@ -1073,6 +1083,18 @@ declare namespace Server {
1073
1083
  files: Array<string>;
1074
1084
  has_changes: boolean;
1075
1085
  };
1086
+ type Rule = {
1087
+ id: number;
1088
+ profile: string | null;
1089
+ api_endpoint: string | null;
1090
+ name: string;
1091
+ description: string;
1092
+ cue_title: string;
1093
+ cue_text: string;
1094
+ repeat: boolean;
1095
+ is_enabled: boolean;
1096
+ label: string;
1097
+ };
1076
1098
  }
1077
1099
  type ConversationMessage = CamelCaseKeys<Omit<Server.ConversationMessage, 'tags'>> & {
1078
1100
  tags: Record<string, string> | null;
@@ -1180,6 +1202,7 @@ declare class DeepdeskAPI {
1180
1202
  getProfile(profileCode: string): Promise<CamelCaseKeys<Server.Profile>>;
1181
1203
  getKnowledgeAssistant(code: string): Promise<CamelCaseKeys<Server.KnowledgeAssistant>>;
1182
1204
  getContentTypes(): Promise<CamelCaseKeys<Server.ContentType[]>>;
1205
+ getAccount(): Promise<CamelCaseKeys<Server.Account>>;
1183
1206
  getPlatformConfig(): Promise<CamelCaseKeys<Server.PlatformConfig['config']>>;
1184
1207
  checkUserExists(externalId: string): Promise<boolean>;
1185
1208
  getConversationBySessionId(sessionId: string, options?: RetryOptions): Promise<CamelCaseKeys<Server.Conversation>>;
@@ -1276,6 +1299,7 @@ declare class DeepdeskAPI {
1276
1299
  evaluateRule<Payload = unknown>(label: string, conversationId: string, payload: Payload, opts?: {
1277
1300
  raiseForFailingConditions?: boolean;
1278
1301
  }): Promise<CamelCaseKeys<Server.Cue[]>>;
1302
+ getRules(): Promise<CamelCaseKeys<Server.Rule[]>>;
1279
1303
  translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
1280
1304
  private handleDeepdeskVersionHeaders;
1281
1305
  }
@@ -2207,6 +2231,9 @@ type PlatformConfig = {
2207
2231
  };
2208
2232
  };
2209
2233
  };
2234
+ /**
2235
+ * @deprecated Use DeepdeskAPI.getPlatformConfig() in stead.
2236
+ */
2210
2237
  declare function fetchPlatformConfig(accountOrigin: string): Promise<PlatformConfig>;
2211
2238
 
2212
2239
  declare function escapeHTML(text: string): string;