@memori.ai/memori-api-client 2.1.5 → 2.2.0

package/esm/engine.d.ts

@@ -389,40 +389,6 @@ declare const _default: (apiUrl: string) => {
             intentSlotID: string;
         }>;
     };
-    importCSV: (sessionId: string, rows: string[], params: import("./types").ImportParams) => Promise<import("./types").ResponseSpec & {
-        status: import("./types").ImportResponse;
-    }>;
-    importProcesses: (sessionId: string) => Promise<import("./types").ResponseSpec & {
-        importProcesses: import("./types").ImportResponse[];
-    }>;
-    importStatus: (importID: string) => Promise<import("./types").ResponseSpec & {
-        status: import("./types").ImportResponse;
-    }>;
-    stopImport: (importID: string) => Promise<import("./types").ResponseSpec & {
-        status: import("./types").ImportResponse;
-    }>;
-    importTXT: (sessionId: string, rows: string[], params: Omit<import("./types").ImportParams, "csvSpecs">) => Promise<import("./types").ResponseSpec & {
-        status: import("./types").ImportResponse;
-    }>;
-    exportCSV: (sessionID: string, params: import("./types").ExportCSVParams) => Promise<string>;
-    importExport: {
-        importCSV: (sessionId: string, rows: string[], params: import("./types").ImportParams) => Promise<import("./types").ResponseSpec & {
-            status: import("./types").ImportResponse;
-        }>;
-        importProcesses: (sessionId: string) => Promise<import("./types").ResponseSpec & {
-            importProcesses: import("./types").ImportResponse[];
-        }>;
-        importStatus: (importID: string) => Promise<import("./types").ResponseSpec & {
-            status: import("./types").ImportResponse;
-        }>;
-        stopImport: (importID: string) => Promise<import("./types").ResponseSpec & {
-            status: import("./types").ImportResponse;
-        }>;
-        importTXT: (sessionId: string, rows: string[], params: Omit<import("./types").ImportParams, "csvSpecs">) => Promise<import("./types").ResponseSpec & {
-            status: import("./types").ImportResponse;
-        }>;
-        exportCSV: (sessionID: string, params: import("./types").ExportCSVParams) => Promise<string>;
-    };
     postTextEnteredEvent: ({ sessionId, text, }: {
         sessionId: string;
         text: string;

package/esm/engine.js

@@ -1,6 +1,5 @@
 import correlationPairs from './engine/correlationPairs';
 import dialog from './engine/dialog';
-import importExport from './engine/importExport';
 import intents from './engine/intents';
 import localizationKeys from './engine/localizationKeys';
 import media from './engine/media';
@@ -20,8 +19,6 @@ export default (apiUrl) => ({
     ...correlationPairs(apiUrl),
     dialog: dialog(apiUrl),
     ...dialog(apiUrl),
-    importExport: importExport(apiUrl),
-    ...importExport(apiUrl),
     intents: intents(apiUrl),
     ...intents(apiUrl),
     localizationKeys: localizationKeys(apiUrl),

package/esm/engine.js.map

@@ -1 +1 @@
-{"version":3,"file":"engine.js","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,gBAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,GAAG,MAAM,cAAc,CAAC;AAC/B,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,iBAAiB,MAAM,4BAA4B,CAAC;AAC3D,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,mBAAmB,MAAM,8BAA8B,CAAC;AAC/D,OAAO,WAAW,MAAM,sBAAsB,CAAC;AAC/C,OAAO,gBAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,eAAe,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAClC,gBAAgB,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC1C,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjB,YAAY,EAAE,YAAY,CAAC,MAAM,CAAC;IAClC,GAAG,YAAY,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;IACxB,GAAG,OAAO,CAAC,MAAM,CAAC;IAClB,gBAAgB,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC1C,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC3B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;IACpB,GAAG,KAAK,CAAC,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC1B,GAAG,QAAQ,CAAC,MAAM,CAAC;IACnB,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC;IAChB,GAAG,GAAG,CAAC,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjB,iBAAiB,EAAE,iBAAiB,CAAC,MAAM,CAAC;IAC5C,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;IACxB,GAAG,OAAO,CAAC,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;IACpB,GAAG,KAAK,CAAC,MAAM,CAAC;IAChB,mBAAmB,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAChD,GAAG,mBAAmB,CAAC,MAAM,CAAC;IAC9B,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC;IAChC,GAAG,WAAW,CAAC,MAAM,CAAC;IACtB,gBAAgB,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC1C,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC1B,GAAG,QAAQ,CAAC,MAAM,CAAC;CACpB,CAAC,CAAC"}
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,gBAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,GAAG,MAAM,cAAc,CAAC;AAC/B,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,iBAAiB,MAAM,4BAA4B,CAAC;AAC3D,OAAO,MAAM,MAAM,iBAAiB,CAAC;AACrC,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,mBAAmB,MAAM,8BAA8B,CAAC;AAC/D,OAAO,WAAW,MAAM,sBAAsB,CAAC;AAC/C,OAAO,gBAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,eAAe,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;IAClC,gBAAgB,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC1C,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;IACxB,GAAG,OAAO,CAAC,MAAM,CAAC;IAClB,gBAAgB,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC1C,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC3B,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;IACpB,GAAG,KAAK,CAAC,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC1B,GAAG,QAAQ,CAAC,MAAM,CAAC;IACnB,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC;IAChB,GAAG,GAAG,CAAC,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjB,iBAAiB,EAAE,iBAAiB,CAAC,MAAM,CAAC;IAC5C,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IACtB,GAAG,MAAM,CAAC,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC;IACxB,GAAG,OAAO,CAAC,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;IACpB,GAAG,KAAK,CAAC,MAAM,CAAC;IAChB,mBAAmB,EAAE,mBAAmB,CAAC,MAAM,CAAC;IAChD,GAAG,mBAAmB,CAAC,MAAM,CAAC;IAC9B,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC;IAChC,GAAG,WAAW,CAAC,MAAM,CAAC;IACtB,gBAAgB,EAAE,gBAAgB,CAAC,MAAM,CAAC;IAC1C,GAAG,gBAAgB,CAAC,MAAM,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC;IAC1B,GAAG,QAAQ,CAAC,MAAM,CAAC;CACpB,CAAC,CAAC"}

package/esm/index.d.ts

@@ -394,40 +394,6 @@ declare const api: (hostname?: string) => {
             intentSlotID: string;
         }>;
     };
-    importCSV: (sessionId: string, rows: string[], params: import("./types").ImportParams) => Promise<import("./types").ResponseSpec & {
-        status: import("./types").ImportResponse;
-    }>;
-    importProcesses: (sessionId: string) => Promise<import("./types").ResponseSpec & {
-        importProcesses: import("./types").ImportResponse[];
-    }>;
-    importStatus: (importID: string) => Promise<import("./types").ResponseSpec & {
-        status: import("./types").ImportResponse;
-    }>;
-    stopImport: (importID: string) => Promise<import("./types").ResponseSpec & {
-        status: import("./types").ImportResponse;
-    }>;
-    importTXT: (sessionId: string, rows: string[], params: Omit<import("./types").ImportParams, "csvSpecs">) => Promise<import("./types").ResponseSpec & {
-        status: import("./types").ImportResponse;
-    }>;
-    exportCSV: (sessionID: string, params: import("./types").ExportCSVParams) => Promise<string>;
-    importExport: {
-        importCSV: (sessionId: string, rows: string[], params: import("./types").ImportParams) => Promise<import("./types").ResponseSpec & {
-            status: import("./types").ImportResponse;
-        }>;
-        importProcesses: (sessionId: string) => Promise<import("./types").ResponseSpec & {
-            importProcesses: import("./types").ImportResponse[];
-        }>;
-        importStatus: (importID: string) => Promise<import("./types").ResponseSpec & {
-            status: import("./types").ImportResponse;
-        }>;
-        stopImport: (importID: string) => Promise<import("./types").ResponseSpec & {
-            status: import("./types").ImportResponse;
-        }>;
-        importTXT: (sessionId: string, rows: string[], params: Omit<import("./types").ImportParams, "csvSpecs">) => Promise<import("./types").ResponseSpec & {
-            status: import("./types").ImportResponse;
-        }>;
-        exportCSV: (sessionID: string, params: import("./types").ExportCSVParams) => Promise<string>;
-    };
     postTextEnteredEvent: ({ sessionId, text, }: {
         sessionId: string;
         text: string;
@@ -503,6 +469,22 @@ declare const api: (hostname?: string) => {
         deleteCorrelationPair: (sessionId: string, pairId: string) => Promise<import("./types").ResponseSpec>;
     };
     backend: {
+        importCSV: (authToken: string, memoriID: string, rows: string[], params: Omit<import("./types").ImportParams, "txtSpecs">) => Promise<import("./types").ResponseSpec & {
+            status: import("./types").ImportResponse;
+        }>;
+        importTXT: (authToken: string, memoriID: string, rows: string[], params: Omit<import("./types").ImportParams, "csvSpecs">) => Promise<import("./types").ResponseSpec & {
+            status: import("./types").ImportResponse;
+        }>;
+        importProcesses: (authToken: string) => Promise<import("./types").ResponseSpec & {
+            importProcesses: import("./types").ImportResponse[];
+        }>;
+        importStatus: (authToken: string, importID: string) => Promise<import("./types").ResponseSpec & {
+            status: import("./types").ImportResponse;
+        }>;
+        stopImport: (authToken: string, importID: string) => Promise<import("./types").ResponseSpec & {
+            status: import("./types").ImportResponse;
+        }>;
+        exportCSV: (authToken: string, memoriID: string, csvSpecs: import("./types").CsvSpecs, password?: string | undefined) => Promise<string>;
         getTenantNotifications: (tenantID: string) => Promise<import("./types").ResponseSpec & {
             notifications: import("./types").Notification[];
         }>;
@@ -845,6 +827,24 @@ declare const api: (hostname?: string) => {
                 notifications: import("./types").Notification[];
             }>;
         };
+        importExport: {
+            importCSV: (authToken: string, memoriID: string, rows: string[], params: Omit<import("./types").ImportParams, "txtSpecs">) => Promise<import("./types").ResponseSpec & {
+                status: import("./types").ImportResponse;
+            }>;
+            importTXT: (authToken: string, memoriID: string, rows: string[], params: Omit<import("./types").ImportParams, "csvSpecs">) => Promise<import("./types").ResponseSpec & {
+                status: import("./types").ImportResponse;
+            }>;
+            importProcesses: (authToken: string) => Promise<import("./types").ResponseSpec & {
+                importProcesses: import("./types").ImportResponse[];
+            }>;
+            importStatus: (authToken: string, importID: string) => Promise<import("./types").ResponseSpec & {
+                status: import("./types").ImportResponse;
+            }>;
+            stopImport: (authToken: string, importID: string) => Promise<import("./types").ResponseSpec & {
+                status: import("./types").ImportResponse;
+            }>;
+            exportCSV: (authToken: string, memoriID: string, csvSpecs: import("./types").CsvSpecs, password?: string | undefined) => Promise<string>;
+        };
     };
 };
 export default api;

package/esm/types.d.ts

@@ -227,6 +227,12 @@ export declare type OpenSession = {
     initialQuestion?: string;
     forceCloseSessions?: boolean;
     birthDate?: string;
+    additionalInfo?: {
+        userID?: string;
+        email?: string;
+        language?: string;
+        referral?: string;
+    };
 };
 export declare type MemoriSession = {
     sessionID: string;
@@ -587,7 +593,8 @@ export type CustomWord = {
     lastChangeTimestamp: string;
     lastChangeSessionID: string;
 };
-export interface ImportCSVParams {
+export interface CsvSpecs {
+    newLine: '\n' | '\r\n';
     hasHeaders?: boolean;
     headerNames?: string[];
     questionColumnName: string;
@@ -597,34 +604,25 @@ export interface ImportCSVParams {
     csvSeparator?: string;
     questionTitleVariantsSeparator?: string;
 }
-export interface ImportTxtParams {
-    newLinesPerParagraphs?: number;
+export interface TxtSpecs {
+    granularity?: 'LOW' | 'MEDIUM' | 'HIGH';
+    attachSource?: boolean;
+    sourceAttachmentTitle?: string;
+    questionsGenerationInstructions?: string;
 }
 export interface ImportParams {
-    includedRows?: number[];
     forceImport?: boolean;
-    csvSpecs?: ImportCSVParams;
-    txtSpecs?: ImportTxtParams;
+    csvSpecs?: CsvSpecs;
+    txtSpecs?: TxtSpecs;
     conclusive?: boolean;
     notPickable?: boolean;
     contextVarsToSet?: {
         [key: string]: string;
     };
 }
-export interface ExportCSVParams {
-    newLine: '\n' | '\r\n';
-    hasHeaders?: boolean;
-    questionColumnName: string;
-    answerColumnName: string;
-    contextVarsToMatchColumnName?: string;
-    contextVarsToSetColumnName?: string;
-    csvSeparator?: string;
-    questionTitleVariantsSeparator?: string;
-}
 export interface ImportWarning {
     warningType: 'Existing Similar Memory' | 'Internal Error';
     rowNumber?: number;
-    row: string;
     text?: string;
     similarTexts?: {
         text: string;
@@ -633,12 +631,26 @@ export interface ImportWarning {
 }
 export interface ImportResponse {
     importID: string;
-    status: 'Starting' | 'Running' | 'Stopped' | 'Completed' | 'Failed';
+    status: 'Pending' | 'Starting' | 'Running' | 'Stopped' | 'Completed' | 'Failed';
     error?: string;
     progress: number;
+    importType: 'CSV' | 'TXT';
+    importSize: number;
     begin?: string;
     end?: string;
     eta?: number;
     importedMemories?: number;
     importWarnings?: ImportWarning[];
 }
+export interface Badge {
+    badgeID?: string;
+    date?: string;
+    name?: string;
+    description?: string;
+    imageURL?: string;
+    tags?: string[];
+    issuerName?: string;
+    issuerDescription?: string;
+    issuerEmail?: string;
+    issuerURL?: string;
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.5",
+  "version": "2.2.0",
   "name": "@memori.ai/memori-api-client",
   "description": "React library to integrate a Memori in your app or website",
   "license": "Apache-2.0",

package/src/backend/importExport.test.ts

@@ -0,0 +1,23 @@
+import memori from '../index';
+
+const client = memori('https://backend-staging.memori.ai');
+
+describe('backend/importexport api', () => {
+  it('works on importexport apis', async () => {
+    expect(
+      await client.backend.importExport.importStatus(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+
+  it('works on importexport apis with shorthand version', async () => {
+    expect(
+      await client.backend.importStatus(
+        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
+        'be2e4a44-890b-483b-a26a-f6e122f36e2b'
+      )
+    ).not.toBeNull();
+  });
+});

package/src/backend/importExport.ts

@@ -0,0 +1,135 @@
+import type {
+  ResponseSpec,
+  ImportParams,
+  ImportResponse,
+  CsvSpecs,
+} from '../types';
+import { apiFetcher } from '../apiFetcher';
+
+/************************
+ *                      *
+ *     ImportExport     *
+ *                      *
+ ************************/
+
+export default (apiUrl: string) => ({
+  /**
+   * Starts an Import process for memories from a CSV file.
+   * @param {string} authToken - The login token.
+   * @param {string} memoriID - The ID of the Memori object.
+   * @param {string[]} rows Rows of the CSV file.
+   * @param {ImportParams} params The specifications and content of the CSV file
+   */
+  importCSV: async (
+    authToken: string,
+    memoriID: string,
+    rows: string[],
+    params: Omit<ImportParams, 'txtSpecs'>
+  ) =>
+    apiFetcher(`/ImportExport/ImportCSV/${authToken}/${memoriID}`, {
+      apiUrl,
+      method: 'POST',
+      body: {
+        rows,
+        ...params,
+      },
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
+
+  /**
+   * Starts an Import process for memories from a TXT file.
+   * @param {string} authToken - The login token.
+   * @param {string} memoriID - The ID of the Memori object.
+   * @param {string[]} rows Rows of the TXT file.
+   * @param {ImportParams} params The specifications and content of the TXT file
+   */
+  importTXT: async (
+    authToken: string,
+    memoriID: string,
+    rows: string[],
+    params: Omit<ImportParams, 'csvSpecs'>
+  ) =>
+    apiFetcher(`/ImportExport/ImportTXT/${authToken}/${memoriID}`, {
+      apiUrl,
+      method: 'POST',
+      body: {
+        rows,
+        ...params,
+      },
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
+
+  /**
+   * Gets a list of Import processes started by the currently logged in User.
+   * @param {string} authToken - The login token.
+   */
+  importProcesses: async (authToken: string) =>
+    apiFetcher(`/ImportExport/ImportProcesses/${authToken}`, {
+      apiUrl,
+      method: 'GET',
+    }) as Promise<
+      ResponseSpec & {
+        importProcesses: ImportResponse[];
+      }
+    >,
+
+  /**
+   * Gets the status of an Import process.
+   * @param {string} authToken - The login token.
+   * @param {string} importID The import process ID
+   */
+  importStatus: async (authToken: string, importID: string) =>
+    apiFetcher(`/ImportExport/ImportStatus/${authToken}/${importID}`, {
+      apiUrl,
+      method: 'GET',
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
+
+  /**
+   * Interrupts an ongoing Import process.
+   * @param {string} authToken - The login token.
+   * @param {string} importID The import process ID
+   */
+  stopImport: async (authToken: string, importID: string) =>
+    apiFetcher(`/ImportExport/StopImport/${authToken}/${importID}`, {
+      apiUrl,
+      method: 'POST',
+    }) as Promise<
+      ResponseSpec & {
+        status: ImportResponse;
+      }
+    >,
+
+  /**
+   * Exports contents of a Memori object to a CSV file.
+   * @param {string} authToken - The login token.
+   * @param {string} memoriID - The ID of the Memori object.
+   * @param {CsvSpecs} csvSpecs - The specifications of the CSV file
+   * @param {string=} password - Memori password, if its privacy model is set to Secret.
+   * @returns The CSV file content
+   */
+  exportCSV: async (
+    authToken: string,
+    memoriID: string,
+    csvSpecs: CsvSpecs,
+    password?: string
+  ) =>
+    apiFetcher(`/ImportExport/ExportCSV/${authToken}/${memoriID}`, {
+      apiUrl,
+      method: 'POST',
+      body: {
+        csvSpecs,
+        password,
+      },
+      text: true,
+    }) as Promise<string>,
+});

package/src/backend.ts

@@ -5,6 +5,7 @@ import asset from './backend/asset';
 import invitation from './backend/invitation';
 import consumptionLogs from './backend/consumptionLogs';
 import notifications from './backend/notifications';
+import importExport from './backend/importExport';
 
 const backendAPI = (apiUrl: string) => ({
   asset: asset(apiUrl),
@@ -14,6 +15,7 @@ const backendAPI = (apiUrl: string) => ({
   invitation: invitation(apiUrl),
   consumptionLogs: consumptionLogs(apiUrl),
   notifications: notifications(apiUrl),
+  importExport: importExport(apiUrl),
   ...asset(apiUrl),
   ...memori(apiUrl),
   ...user(apiUrl),
@@ -21,6 +23,7 @@ const backendAPI = (apiUrl: string) => ({
   ...invitation(apiUrl),
   ...consumptionLogs(apiUrl),
   ...notifications(apiUrl),
+  ...importExport(apiUrl),
 });
 
 export default backendAPI;

package/src/engine.ts

@@ -1,6 +1,5 @@
 import correlationPairs from './engine/correlationPairs';
 import dialog from './engine/dialog';
-import importExport from './engine/importExport';
 import intents from './engine/intents';
 import localizationKeys from './engine/localizationKeys';
 import media from './engine/media';
@@ -21,8 +20,6 @@ export default (apiUrl: string) => ({
   ...correlationPairs(apiUrl),
   dialog: dialog(apiUrl),
   ...dialog(apiUrl),
-  importExport: importExport(apiUrl),
-  ...importExport(apiUrl),
   intents: intents(apiUrl),
   ...intents(apiUrl),
   localizationKeys: localizationKeys(apiUrl),

package/src/types.ts

@@ -280,6 +280,12 @@ export declare type OpenSession = {
   initialQuestion?: string;
   forceCloseSessions?: boolean;
   birthDate?: string;
+  additionalInfo?: {
+    userID?: string;
+    email?: string;
+    language?: string;
+    referral?: string;
+  };
 };
 
 export declare type MemoriSession = {
@@ -862,7 +868,8 @@ export type CustomWord = {
   lastChangeSessionID: string;
 };
 
-export interface ImportCSVParams {
+export interface CsvSpecs {
+  newLine: '\n' | '\r\n';
   hasHeaders?: boolean;
   headerNames?: string[];
   questionColumnName: string;
@@ -873,36 +880,48 @@ export interface ImportCSVParams {
   questionTitleVariantsSeparator?: string;
 }
 
-export interface ImportTxtParams {
-  newLinesPerParagraphs?: number;
+export interface TxtSpecs {
+  /**
+   * @type {string=}
+   * Proportion between the text size and the number of question-answers generated. If not specified it is assumed as MEDIUM.
+   * Must be one of:
+   * -  LOW: generates ~10 questions every 10K characters
+   * -  MEDIUM: generates ~20 questions every 10K characters
+   * -  HIGH: generates ~30 questions every 10K characters
+   */
+  granularity?: 'LOW' | 'MEDIUM' | 'HIGH';
+  /**
+   * @type {boolean=}
+   * If True, for every question-answer the excerpt of the original text from which they have been generated is included as an attachment.
+   * If not specified it is assumed as False.
+   */
+  attachSource?: boolean;
+  /**
+   * @type {string=}
+   * Title of the source attachment, when enabled with AttachSource. If not specified it will have no title.
+   */
+  sourceAttachmentTitle?: string;
+  /**
+   * @type {string=}
+   * If specified, these instructions are provided as part of the completion prompt to the generative AI when generating questions from the document.
+   */
+  questionsGenerationInstructions?: string;
 }
 
 export interface ImportParams {
-  includedRows?: number[];
   forceImport?: boolean;
-  csvSpecs?: ImportCSVParams;
-  txtSpecs?: ImportTxtParams;
+  csvSpecs?: CsvSpecs;
+  txtSpecs?: TxtSpecs;
   conclusive?: boolean;
   notPickable?: boolean;
   contextVarsToSet?: {
     [key: string]: string;
   };
 }
-export interface ExportCSVParams {
-  newLine: '\n' | '\r\n';
-  hasHeaders?: boolean;
-  questionColumnName: string;
-  answerColumnName: string;
-  contextVarsToMatchColumnName?: string;
-  contextVarsToSetColumnName?: string;
-  csvSeparator?: string;
-  questionTitleVariantsSeparator?: string;
-}
 
 export interface ImportWarning {
   warningType: 'Existing Similar Memory' | 'Internal Error';
   rowNumber?: number;
-  row: string;
   text?: string;
   similarTexts?: {
     text: string;
@@ -927,7 +946,13 @@ export interface ImportResponse {
    * - Completed: the Import process finished successfully, all the Memory objects have been processed.
    * - Failed: the Import process terminated due to an unexpected error, not all Memory objects may have been processed.
    */
-  status: 'Starting' | 'Running' | 'Stopped' | 'Completed' | 'Failed';
+  status:
+    | 'Pending'
+    | 'Starting'
+    | 'Running'
+    | 'Stopped'
+    | 'Completed'
+    | 'Failed';
   /**
    * @type {string=}
    * If the Status is Failed, reports the error that caused the Import process to fail. Null otherwise.
@@ -938,6 +963,18 @@ export interface ImportResponse {
    * Progress of the Import process as a fraction of 1.
    */
   progress: number;
+  /**
+   * @type {string}
+   * Import type.  Can be one of the following:
+   * -  CSV: for tabular documents
+   * -  TXT: for text documents
+   */
+  importType: 'CSV' | 'TXT';
+  /**
+   * @type {number}
+   * Size of the imported document in characters.
+   */
+  importSize: number;
   /**
    * @type {string=}
    * Timestamp of start of the Import process. Null until the Import process is in Starting status.
@@ -964,3 +1001,16 @@ export interface ImportResponse {
    */
   importWarnings?: ImportWarning[];
 }
+
+export interface Badge {
+  badgeID?: string;
+  date?: string;
+  name?: string;
+  description?: string;
+  imageURL?: string;
+  tags?: string[];
+  issuerName?: string;
+  issuerDescription?: string;
+  issuerEmail?: string;
+  issuerURL?: string;
+}

package/src/engine/importExport.test.ts

@@ -1,38 +0,0 @@
-import { ImportParams } from '../../src/types';
-import memori from '../index';
-
-const client = memori('https://backend.memori.ai');
-
-describe('engine/importExport api', () => {
-  const importCsvParams: ImportParams = {
-    includedRows: [0, 1],
-    forceImport: false,
-    csvSpecs: {
-      hasHeaders: false,
-      questionColumnName: 'Title',
-      answerColumnName: 'Answers',
-      csvSeparator: ',',
-      questionTitleVariantsSeparator: '|',
-    },
-  };
-
-  it('works on import apis', async () => {
-    expect(
-      await client.importExport.importCSV(
-        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
-        ['Title,Answers', 'Chi sei?,Sono un Memori'],
-        importCsvParams
-      )
-    ).not.toBeNull();
-  });
-
-  it('works on import apis with shorthand version', async () => {
-    expect(
-      await client.importCSV(
-        '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
-        ['Title,Answers', 'Chi sei?,Sono un Memori'],
-        importCsvParams
-      )
-    ).not.toBeNull();
-  });
-});