@memori.ai/memori-api-client 0.2.0 → 0.3.0

package/src/types.ts

@@ -45,14 +45,19 @@ export declare type Memori = {
   culture?: string;
   publishedInTheMetaverse?: boolean;
   metaverseEnvironment?: string;
+  exposed?: boolean;
   properties?: { [key: string]: string };
   creationTimestamp?: string;
   lastChangeTimestamp?: string;
+  blockedUntil?: string;
   integrations?: Integration[];
   sentInvitations?: Invitation[];
   receivedInvitations?: Invitation[];
   categories?: string[];
   ownerUserName?: string;
+  gamificationLevel?: GamificationLevel;
+  contentQualityIndex?: number;
+  contentQualityIndexTimestamp?: string;
 };
 
 export declare type Venue = {
@@ -62,6 +67,32 @@ export declare type Venue = {
   uncertainty?: number;
 };
 
+export declare type NotificationPrefs = {
+  /**
+   * @type {string='None'}
+   * minLength: 1
+   * Periodicity of chat log extraction (hourly, daily, weekly or none).
+   * When chat log extraction is enabled (i.e. not None) chats performed on Memori owned or managed by the User
+   * will be periodically collected and sent via e-mail.
+   */
+  chatLogExtractionPeriod?: 'None' | 'Hourly' | 'Daily' | 'Weekly';
+
+  /**
+   * @type {number=5}
+   * Minimum lines for an extracted chat to be sent via e-mail to the User.
+   * If 0 no filter is applied.
+   * Default is 5.
+   */
+  chatLogExtractionMinLines?: number;
+
+  /**
+   * @type {string=}
+   * Memori ID to which these preferences apply to.
+   * If Null these preferences have default value and apply to all Memori objects not specified with other preferences.
+   */
+  memoriID?: string;
+};
+
 export declare type User = {
   tenant?: string;
   userID?: string;
@@ -77,12 +108,18 @@ export declare type User = {
   maxMemori?: number;
   canCreateMemori?: boolean;
   canAccessAPI?: boolean;
+  canRunSnippets?: boolean;
   canEditIntegrations?: boolean;
   canEditDynamicIntents?: boolean;
   canEditMemoriChaining?: boolean;
   maxFreeSessions?: number;
+  nonFreeSessionCost?: number;
   creationTimestamp?: string;
   lastChangeTimestamp?: string;
+  referral?: string;
+  couponCode?: string;
+  paying?: boolean;
+  notificationPrefs?: NotificationPrefs[];
 };
 
 export declare type IntegrationResource = {
@@ -180,6 +217,7 @@ export declare type Tenant = {
   usersCanEditMemoriChaining?: boolean;
   maxFreeSessions?: number;
   maxFreeSessionsPerUser?: number;
+  nonFreeSessionCost?: number;
 };
 
 export declare type OpenSession = {
@@ -233,7 +271,7 @@ export declare type GamificationLevel = {
   points: number;
   badge: string;
   pointsForCurrentBadge: number;
-  nextBadge: {
+  nextBadge?: {
     points: number;
     badge: string;
   };
@@ -434,7 +472,295 @@ export declare type UnansweredQuestion = {
 
 export declare type Message = {
   text: string;
+  translatedText?: string;
   fromUser?: boolean;
   media?: Medium[];
   initial?: boolean;
+  timestamp?: string;
+  contextVars?: { [key: string]: string };
+};
+
+export type ConsumptionLog = {
+  consumptionLogID: string;
+  from: string;
+  to: string;
+  type: 'Daily' | 'Monthly';
+  userID?: string;
+  memoriID?: string;
+  totalSessions: number;
+  validSessions: number;
+};
+
+export type Notification = {
+  notificationID: string;
+  timestamp: string;
+  severity: 'INFO' | 'WARN' | 'ALERT';
+  texts: {
+    'it-IT': string;
+    'en-US': string;
+    [lang: string]: string;
+  };
+};
+
+export type ChatMedium = {
+  /**
+   * URL of the Medium. If specified, the Content property is Null.
+   */
+  url?: string;
+  /**
+   * Content of the Medium. If specified, the URL property is Null.
+   */
+  content?: string;
+  /**
+   * MIME type of the Medium.
+   */
+  mimeType: string;
+  /**
+   * Title of the Medium.
+   */
+  title?: string;
+  /**
+   * Key-value pairs for additional structured content storage.
+   */
+  properties?: { [key: string]: string };
+};
+
+export type ChatLogLine = {
+  /**
+   * @type {string}
+   * Timestamp UTC of the line.
+   */
+  timestamp: string;
+  /**
+   * @type {boolean}
+   * If True the line is the text from a Text Entered Event. If False the line is Dialog State Machine emission.
+   */
+  inbound: boolean;
+  /**
+   * @type {string}
+   * Text of the line.
+   */
+  text: string;
+  /**
+   * Media attached with the Dialog State Machine emission, if present. Empty if the line is inbound.
+   */
+  media?: ChatMedium[];
+  /**
+   * Dialog State Machine context variables after the emission, if present. Empty if the line is inbound.
+   */
+  contextVars?: { [key: string]: string };
+};
+
+export type ChatLog = {
+  /**
+   * @param {string}
+   * Chat Log object ID.
+   */
+  chatLogID: string;
+  /**
+   * @type {string}
+   * Timestamp UTC of the chat log creation.
+   */
+  timestamp: string;
+  /**
+   * @type {string}
+   * ID of the related Memori object in the Engine.
+   * Relates to Memori.engineMemoriID
+   */
+  memoriID: string;
+  /**
+   * @type {string}
+   * ID of the related session.
+   */
+  sessionID: string;
+  /**
+   * @type {?string}
+   * Tag of the Person object authenticated in the session. Null if the chat was performed by anonymous.
+   */
+  receiverTag?: string;
+
+  /**
+   * List of Chat Line objects of this chat.
+   */
+  lines: ChatLogLine[];
+};
+
+export type Utterance = {
+  /**
+   * Utterance object ID.
+   */
+  utteranceID?: string;
+  /**
+   * Accepted Utterance object for its corresponding intent,
+   * i.e. the text sentece that can be used to express the intent.
+   * An Utterance may include variable parts in the sentence by the use of one or more slots.
+   * Slots are specified using the syntax {slot}, where "slot" is the slot name.
+   * If present, their value is part of the IntentWebHookRequest passed to the web hook.
+   * Each slot can be present only once in the sentence, and must have been previously defined with a Intent Slot object.
+   * A special slot is the {date} slot, which represents a period of time such as "today", "yesterday", "last week", "next month" etc.
+   * Its values is passed in the IntentWebHookRequest as the BeginUTC and EndUTC properties.
+   */
+  text: string;
+  /**
+   * Timestamp of creation.
+   * Always present when reading/receiving an object,
+   * ignored when writing/sending an object.
+   */
+  creationTimestamp?: string;
+  /**
+   * ID of the session that created this object.
+   */
+  creationSessionID?: string;
+  /**
+   * Timestamp of latest change.
+   * Always present when reading/receiving an object,
+   * ignored when writing/sending an object.
+   */
+  lastChangeTimestamp?: string;
+  /**
+   * ID of the latest session that changed this object.
+   */
+  lastChangeSessionID?: string;
+};
+
+export type Intent = {
+  /**
+   * Intent object ID.
+   */
+  intentID?: string;
+  /**
+   * Memory type, e.g. Internal or WebHook.
+   * Internal intents are a limited subset implemented internally,
+   * while WebHook intents perform an external HTTP POST call to the specified web hook,
+   * passing an IntentWebHookRequest and expecting an IntentWebHookRespose in response.
+   * When updating an existing intent, this property is ignored.
+   */
+  intentType?: 'Internal' | 'WebHook';
+  /**
+   * Name of the Intent object.
+   * It is part of the IntentWebHookRequest request passed to the web hook.
+   */
+  name: string;
+  /**
+   * List of accepted Utterance objects for this Intent,
+   * i.e. the list of text senteces that can be used to express the intent.
+   * Utterances may include variable parts in the sentence by the use of one or more slots.
+   * Slots are specified using the syntax {slot}, where "slot" is the slot name.
+   * If present, their value is part of the IntentWebHookRequest passed to the web hook.
+   * Each slot can be present only once in the sentence, and must have been previously defined with a Intent Slot object.
+   * A special slot is the {date} slot, which represents a period of time such as "today", "yesterday", "last week", "next month" etc.
+   * Its values is passed in the IntentWebHookRequest as the BeginUTC and EndUTC properties.
+   */
+  utterances: Utterance[];
+  /**
+   * If True this Intent may be executed to serve a Timeout event in R1 state.
+   * In this case the utterance is null.
+   * In case more than one Intent have this flag set, a random one is picked.
+   */
+  timeoutIntent?: boolean;
+  /**
+   * HTTP URL of the web hook to be called when the intent is recognized.
+   * If the intent is of Internal type, it is ignored.
+   */
+  webHook?: string;
+  /**
+   * Time to cache the intent response, expressed in minutes.
+   * May be fractional. A minimum of 0.1 minutes (i.e. 6 seconds) is always applied.
+   * A cached intent response is used only when the a subsequent intent request matches exactly the original request.
+   * See also RequestValidityMinutes in WebHookRequest.
+   */
+  validityMinutes?: number;
+  /**
+   * Timestamp of creation.
+   * Always present when reading/receiving an object,
+   * ignored when writing/sending an object.
+   */
+  creationTimestamp?: string;
+  /**
+   * ID of the session that created this object.
+   */
+  creationSessionID?: string;
+  /**
+   * Timestamp of latest change.
+   * Always present when reading/receiving an object,
+   * ignored when writing/sending an object.
+   */
+  lastChangeTimestamp?: string;
+  /**
+   * ID of the latest session that changed this object.
+   */
+  lastChangeSessionID?: string;
+};
+
+export type IntentSlot = {
+  /**
+   * Intent Slot object ID.
+   */
+  intentSlotID?: string;
+  /**
+   * Name of the Intent Slot object.
+   * It is part of the SlotWebHookRequest request passed to the web hook.
+   */
+  name: string;
+  /**
+   * List of possible values of the slot.
+   * A slot may be composed of fixed values in this property,
+   * dynamic values fetched from the web hook, or a combination of both.
+   * Each value is considered only onces (duplicate values are ignored).
+   */
+  values?: string[];
+  /**
+   * HTTP URL of the web hook to be called when the slot values must be fetched.
+   * May be null if the slot is composed only of fixed values in the Values property.
+   * If specified, the web hook is called periodically with an HTTP POST call,
+   * passing a SlotWebHookRequest and expecting a SlotWebHookRespose in response.
+   * Periodicity is determined by the ValidityMinutes property.
+   */
+  webHook?: string;
+  /**
+   * Time to cache the slot values, expressed in minutes.
+   * May be fractional. A minimum of 0.5 minutes (i.e. 30 seconds) is always applied.
+   * See also RequestValidityMinutes in WebHookRequest.
+   */
+  validityMinutes?: number;
+  /**
+   * Timestamp of creation.
+   * Always present when reading/receiving an object,
+   * ignored when writing/sending an object.
+   */
+  creationTimestamp?: string;
+  /**
+   * ID of the session that created this object.
+   */
+  creationSessionID?: string;
+  /**
+   * Timestamp of latest change.
+   * Always present when reading/receiving an object,
+   * ignored when writing/sending an object.
+   */
+  lastChangeTimestamp?: string;
+  /**
+   * ID of the latest session that changed this object.
+   */
+  lastChangeSessionID?: string;
+};
+
+export type CustomWord = {
+  customWordID: string;
+  word: string;
+
+  /**
+   * Definition of the Custom Word, in terms of sums and subtractions of existing words or custom words.
+   * The syntax for a Custom Word definition is as follows: word1 [+-] word2 [+-] word3...
+   * If the operator is omitted it is assumed to be the last specified from the left, and if no operator has been specified it is assumed to be the sum.
+   * E.g.:
+   *  - alpha beta gamma is equivalent to alpha + beta + gamma
+   *  - alpha beta - gamma deta is equivalent to alpha + beta - gamma - delta
+   */
+  definition: string;
+
+  creationTimestamp: string;
+  creationSessionID: string;
+  lastChangeTimestamp: string;
+  lastChangeSessionID: string;
 };