@or-sdk/hitl 0.35.0-beta.2816.0 → 0.35.0

package/src/api/Sessions.ts

@@ -1,6 +1,6 @@
-import _ from 'lodash';
 import URI from 'urijs';
 
+import { DEFAULT_OMIT_FIELDS } from '../constants';
 import {
   Session,
   GetSessionsOptions,
@@ -23,99 +23,139 @@ import {
   DeleteClosedSessionOptions,
   CreateSessionsOptions,
   CreateSessionsResponse,
+  BulkDeleteSessionsOptions,
 } from '../types/sessions';
+
 import { HITLBase } from './HITLBase';
 
 export class Sessions extends HITLBase {
   protected static MODULE_URL = 'sessions';
 
-  protected static SEARCH_URL = 'search';
-  protected static SEARCH_WITH_CONTACTS_URL = 'search-with-contacts';
-  protected static GET_TRIGGERS_URL = 'helpers/triggers';
-  protected static GET_QUEUE_SESSION_URL = 'helpers/queue';
-
-  protected static CLAIM_URL = 'claim';
-  protected static TRANSFER_TO_BOT_URL = 'transfer-to-bot';
-  protected static START_CONVERSATION_URL = 'start-conversation';
-  protected static CLOSE_URL = 'close';
-  protected static REOPEN_URL = 'reopen';
-
+  protected static SEARCH_URL = 'search' as const;
+  protected static SEARCH_WITH_CONTACTS_URL = 'search-with-contacts' as const;
+  protected static GET_TRIGGERS_URL = 'helpers/triggers' as const;
+  protected static GET_QUEUE_SESSION_URL = 'helpers/queue' as const;
+
+  protected static CLAIM_URL = 'claim' as const;
+  protected static TRANSFER_TO_BOT_URL = 'transfer-to-bot' as const;
+  protected static START_CONVERSATION_URL = 'start-conversation' as const;
+  protected static CLOSE_URL = 'close' as const;
+  protected static REOPEN_URL = 'reopen' as const;
+
+  /**
+   * @description Get HitL Sessions
+   * @param options
+   */
   public static async getSessions(
     options: GetSessionsOptions = {}
   ): Promise<GetSessionsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version']);
+    const params = Object.fromEntries(
+      Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key))
+    );
 
     return this.request({
       method: 'GET',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Get HitL Session by id
+   * @param options
+   */
   public static async getSessionById(
-    options: GetSessionByIdOptions
+    { agentId, projection, ...options }: GetSessionByIdOptions
   ): Promise<Session> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl).segment(options.sessionId).href();
-    const params = _.pick(options, ['agentId', 'projection']);
 
     return this.request({
       method: 'GET',
       route,
-      params,
+      params: {
+        agentId,
+        projection,
+      },
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Search HitL Sessions
+   * @param options
+   */
   public static async searchSessions(
-    options: SearchSessionsOptions = {}
+    { agentId, ...options }: SearchSessionsOptions = {}
   ): Promise<SearchSessionsResponse> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl).segment(this.SEARCH_URL).href();
-    const params = _.pick(options, ['agentId']);
-    const data = _.omit(options, ['agentId', 'version']);
+    const data = Object.fromEntries(
+      Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key))
+    );
 
     return this.request({
       method: 'POST',
       route,
-      params,
+      params: { agentId },
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Search HitL Sessions and return a list of found Sessions with their Contacts
+   * @param options
+   */
   public static async searchSessionsWithContacts(
-    options: SearchSessionsWithContactsOptions = {}
+    { agentId, ...options }: SearchSessionsWithContactsOptions = {}
   ): Promise<SearchSessionsWithContactsResponse> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl)
       .segment(this.SEARCH_WITH_CONTACTS_URL)
       .href();
 
-    const params = _.pick(options, ['agentId']);
-    const data = _.omit(options, ['agentId', 'version']);
+    const data = Object.fromEntries(
+      Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key))
+    );
 
     return this.request({
       method: 'POST',
       route,
-      params,
+      params: { agentId },
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Get next HitL Session in the NEEDS_ACTION status
+   * @param options
+   */
   public static async getQueueSession(
-    options: GetQueueSessionOptions
+    { agentId, ruleTags, ...options }: GetQueueSessionOptions
   ): Promise<GetQueueSessionResponse> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl).segment(this.GET_QUEUE_SESSION_URL).href();
-    const params = _.pick(options, ['agentId', 'ruleTags']);
 
     return this.request({
       method: 'GET',
       route,
-      params,
+      params: {
+        agentId,
+        ruleTags,
+      },
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Get a list of "init triggers" for HitL Sessions that
+   * can be started from Agent UI
+   * @param options
+   */
   public static async getSessionInitTriggers(
     options: GetInitTriggersOptions = {}
   ): Promise<GetInitTriggersResponse> {
@@ -125,11 +165,18 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'GET',
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Claim HitL Session by Agent. This will add an Agent id to claimedBy
+   * list of a HitL Session and send a "claimed" event to Request Agent Assistance (HitL)
+   * step in a flow currently in control of that HitL Session
+   * @param options
+   */
   public static async claimSessionByAgent(
-    options: ClaimSessionByAgentOptions
+    { claimBy, params, ...options }: ClaimSessionByAgentOptions
   ): Promise<Session> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl)
@@ -137,19 +184,23 @@ export class Sessions extends HITLBase {
       .segment(this.CLAIM_URL)
       .href();
 
-    const params = _.pick(options, ['claimBy']);
-    const data = _.pick(options, ['params']);
-
     return this.request({
       method: 'POST',
       route,
-      params,
-      data,
+      params: { claimBy },
+      data: { params },
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Transfer HitL Session execution to bot.
+   * This will send an "Unpause" event to Pause Execution (HitL) step in a
+   * flow currently in control of the HitL Session
+   * @param options
+   */
   public static async transferToBot(
-    options: TransferToBotOptions
+    { agentId, params, ...options }: TransferToBotOptions
   ): Promise<Session> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl)
@@ -157,60 +208,79 @@ export class Sessions extends HITLBase {
       .segment(this.TRANSFER_TO_BOT_URL)
       .href();
 
-    const params = _.pick(options, ['agentId']);
-    const data = _.pick(options, ['params']);
-
     return this.request({
       method: 'POST',
       route,
-      params,
-      data,
+      params: { agentId },
+      data: { params },
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Start new HitL Session
+   * @param options
+   */
   public static async startConversation(
-    options: StartConversationOptions
+    { contactId, triggerId, params, ...options }: StartConversationOptions
   ): Promise<Session> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl).segment(this.START_CONVERSATION_URL).href();
 
-    const params = _.pick(options, ['contactId', 'triggerId']);
-    const data = _.pick(options, ['params']);
-
     return this.request({
       method: 'POST',
       route,
-      params,
-      data,
+      params: {
+        contactId,
+        triggerId,
+      },
+      data: { params },
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Update HitL Session
+   * @param options
+   */
   public static async updateSession(
-    options: UpdateSessionOptions
+    { tags, contactId, meta, ...options }: UpdateSessionOptions
   ): Promise<Session> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl).segment(options.sessionId).href();
 
-    const data = _.pick(options, ['tags', 'contactId', 'meta']);
     return this.request({
       method: 'PUT',
       route,
-      data,
+      data: {
+        tags,
+        contactId,
+        meta,
+      },
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Create HitL Session
+   * @param options
+   */
   public static async createSessions(
-    options: CreateSessionsOptions
+    { sessions, ...options }: CreateSessionsOptions
   ): Promise<CreateSessionsResponse> {
     const route = this.getBaseUrl(options);
-    const data = _.pick(options, ['sessions']);
     return this.request({
       method: 'POST',
       route,
-      data,
+      data: { sessions },
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Close HitL Session
+   * @param options
+   */
   public static async closeSession(
     options: CloseSessionOptions
   ): Promise<Session> {
@@ -223,10 +293,14 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'POST',
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
-
+  /**
+   * @description Reopen closed HitL Session
+   * @param options
+   */
   public static async reopenSession(
     options: ReopenSessionOptions
   ): Promise<Session> {
@@ -239,9 +313,14 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'POST',
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Delete closed HitL Session
+   * @param options
+   */
   public static async deleteClosedSession(
     options: DeleteClosedSessionOptions
   ) {
@@ -250,6 +329,33 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'DELETE',
       route,
+      ...this.getBaseSettings(options),
+    });
+  }
+
+  // TODO delete method with typo
+  public static async buldDeleteSessions(
+    { sessionIds, ...options }: BulkDeleteSessionsOptions
+  ) {
+    return this.bulkDeleteSessions({
+      sessionIds,
+      ...options,
+    });
+  }
+
+  /**
+   * @description Delete HitL Sessions in bulk
+   * @param options
+   */
+  public static async bulkDeleteSessions(
+    { sessionIds, ...options }: BulkDeleteSessionsOptions
+  ) {
+    const route = this.getBaseUrl(options);
+    return this.request({
+      method: 'DELETE',
+      route,
+      params: { sessionIds },
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/Settings.ts

@@ -1,60 +1,103 @@
-import _ from 'lodash';
+import URI from 'urijs';
 
+import { DEFAULT_OMIT_FIELDS } from '../constants';
 import {
   DeleteSettingOptions,
+  GetContactBookInfoSettingOptions,
   GetSettingsOptions,
   GetSettingsResponse,
   UpdateSettingsOptions,
   UpdateSettingsResponse,
+  Settings as SettingsType,
 } from '../types/settings';
+
 import { HITLBase } from './HITLBase';
 
 export class Settings extends HITLBase {
   protected static readonly MODULE_URL = 'settings';
+  protected static readonly CONTACT_BOOK_INFO_URL = 'contact-book-info';
   protected static readonly IGNORE_RULE_TAGS_HEADER = 'X-Ignore-Rule-Tags';
 
+  /**
+   * @description Get settings
+   * @param options
+   */
   public static async getSettings(
-    options: GetSettingsOptions = {}
+    { ignoreRuleTags = false, ...options }: GetSettingsOptions = {}
   ): Promise<GetSettingsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version', 'accountId', 'ignoreRuleTags']);
-    const customHeaders = { [this.IGNORE_RULE_TAGS_HEADER]: `${_.get(options, ['ignoreRuleTags']) || false}` };
+    const params = Object.fromEntries(
+      Object.entries(options).filter(([key]) => ![...DEFAULT_OMIT_FIELDS, 'accountId'].includes(key))
+    );
+    const customHeaders = { [this.IGNORE_RULE_TAGS_HEADER]: `${ignoreRuleTags}` };
 
     return this.request({
       route,
       params,
       customHeaders,
+      ...this.getBaseSettings(options),
+    });
+  }
+
+  /**
+   * @description Get contact book info setting using agent rule groups for triggers
+   * @param options
+   */
+  public static async getContactBookInfoSetting(
+    options: GetContactBookInfoSettingOptions = {}
+  ): Promise<SettingsType> {
+    const baseUrl = this.getBaseUrl(options);
+    const route = new URI(baseUrl).segment(this.CONTACT_BOOK_INFO_URL).href();
+    const params = Object.fromEntries(
+      Object.entries(options).filter(([key]) => ![...DEFAULT_OMIT_FIELDS, 'accountId'].includes(key))
+    );
+
+    return this.request({
+      route,
+      params,
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Update setting
+   * @param options
+   */
   public static async updateSettings(
-    options: UpdateSettingsOptions
+    { isCommon, data, settings, ...options }: UpdateSettingsOptions
   ): Promise<UpdateSettingsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.pick(options, ['isCommon']);
-    const data = {
-      data: options.data,
-      settings: options.settings,
-    };
 
     return this.request({
       route,
       method: 'PUT',
-      params,
-      data,
+      params: { isCommon },
+      data: {
+        data,
+        settings,
+      },
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Delete setting
+   * @param options
+   */
+
   public static async deleteSetting(
     options: DeleteSettingOptions
   ): Promise<GetSettingsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version']);
+    const params = Object.fromEntries(
+      Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key))
+    );
 
     return this.request({
       route,
       method: 'DELETE',
       params,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/Tasks.ts

@@ -1,23 +1,24 @@
-import _ from 'lodash';
+import { RunTaskOptions } from '../types/tasks';
 
 import { HITLBase } from './HITLBase';
-import { RunTaskOptions } from '../types/tasks';
 
 export class Tasks extends HITLBase {
   protected static MODULE_URL = 'tasks';
-
+  /**
+   * @description Run task: send events, broadcasting, remove rule group etc
+   * @param options
+   */
   public static async runTask(
-    options: RunTaskOptions
+    { task, data, ...options }: RunTaskOptions
   ): Promise<void> {
     const route = this.getBaseUrl(options);
-    const params = _.pick(options, ['task']);
-    const data = _.pick(options, ['data']);
 
     return this.request({
       method: 'POST',
       route,
-      params,
-      data,
+      params: { task },
+      data: { data },
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/Versions.ts

@@ -1,13 +1,18 @@
 import URI from 'urijs';
 
 import { ApiVersionOptions } from '../types';
-import { HITLBase } from './HITLBase';
 import { GetVersionsListResponse, GetVersionInfoResponse } from '../types/versions';
 
+import { HITLBase } from './HITLBase';
+
 export class Versions extends HITLBase {
   protected static MODULE_URL = 'ui-versions';
   protected static VERSION_INFO = 'version-info';
 
+  /**
+   * @description Get UI available versions
+   * @param options
+   */
   public static async getVersionsList(
     options: ApiVersionOptions
   ): Promise<GetVersionsListResponse> {
@@ -15,9 +20,14 @@ export class Versions extends HITLBase {
 
     return this.request({
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
+  /**
+   * @description Get version info
+   * @param options
+   */
   public static async getVersionInfo(
     options: ApiVersionOptions
   ): Promise<GetVersionInfoResponse> {
@@ -26,6 +36,7 @@ export class Versions extends HITLBase {
 
     return this.request({
       route,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/constants.ts

@@ -1,4 +1,4 @@
-export const SERVICE_KEY = 'hitl-api';
-export const EKS_SERVICE_KEY = 'hitl-eks-api';
+export const SERVICE_KEY = 'hitl-api' as const;
+export const EKS_SERVICE_KEY = 'hitl-eks-api' as const;
 export const HITL_API_SERVICE_KEY = SERVICE_KEY;
-
+export const DEFAULT_OMIT_FIELDS = ['version', 'timeout'];

package/src/index.ts

@@ -1,3 +1,24 @@
 export { HITL, AppError } from './HITL';
 export * from './types';
 export * from './constants';
+export {
+  Migrations as MigrationsApi,
+  Settings as SettingsApi,
+  Agents as AgentsApi,
+  RuleGroups as RuleGroupsApi,
+  ContactRuleGroups as ContactRuleGroupsApi,
+  EventTemplates as EventTemplatesApi,
+  Conferences as ConferencesApi,
+  Filters as FiltersApi,
+  CannedMessages as CannedMessagesApi,
+  Sessions as SessionsApi,
+  SessionEvents as SessionEventsApi,
+  Listeners as ListenersApi,
+  Commands as CommandsApi,
+  ContactsMeta as ContactsMetaApi,
+  Helpers as HelpersApi,
+  Versions as VersionsApi,
+  Tasks as TasksApi,
+  SessionRelations as SessionRelationsApi,
+  Contacts as ContactsApi,
+} from './api';

package/src/types/agents.ts

@@ -4,6 +4,7 @@ import {
   AGENT_BROADCAST_EVENTS,
   USER_ROLE,
 } from '@onereach/types-hitl-api';
+
 import { ApiVersionOptions, NoAccountId } from './common';
 
 /* eslint-disable @typescript-eslint/indent */

package/src/types/canned-messages.ts

@@ -1,4 +1,5 @@
 import { CannedMessages } from '@onereach/types-hitl-api';
+
 import { ApiVersionOptions, NoAccountId } from './common';
 
 /* eslint-disable @typescript-eslint/indent */

package/src/types/commands.ts

@@ -1,4 +1,5 @@
 import { Commands, COMMANDS } from '@onereach/types-hitl-api';
+
 import { ApiVersionOptions } from './common';
 
 /* eslint-disable @typescript-eslint/indent */

package/src/types/common.ts

@@ -1,4 +1,3 @@
-import { Token, CalApiParams } from '@or-sdk/base';
 import {
   AGENT_STATUS,
   APP_ERROR_TYPE,
@@ -8,6 +7,7 @@ import {
   CALL_MEMBER_TYPE,
   SESSION_STATUS,
 } from '@onereach/types-hitl-api';
+import { Token, CalApiParams } from '@or-sdk/base';
 
 export type HITLConfig = {
   readonly token: Token;
@@ -22,6 +22,7 @@ export type Request = <T>(params: CalApiParams) => Promise<T>;
 
 export interface ApiVersionOptions {
   readonly version?: number | string;
+  readonly timeout?: number;
 }
 
 export interface BaseUrlOptions extends ApiVersionOptions {

package/src/types/conferences.ts

@@ -1,4 +1,5 @@
 import { Conferences, CALL_MEMBER_TYPE, CALL_MEMBER_STATUS } from '@onereach/types-hitl-api';
+
 import { ApiVersionOptions, NoAccountId } from './common';
 
 /* eslint-disable @typescript-eslint/indent */

package/src/types/contacts-meta.ts

@@ -1,4 +1,5 @@
 import { ContactsMeta, IDateToString } from '@onereach/types-hitl-api';
+
 import { ApiVersionOptions, NoAccountId } from './common';
 
 export type ContactMeta = IDateToString<ContactsMeta.IContactMeta>;

package/src/types/contacts.ts

@@ -1,4 +1,5 @@
 import { Contacts } from '@onereach/types-hitl-api';
+
 import { ApiVersionOptions } from './common';
 
 /* eslint-disable @typescript-eslint/indent */

package/src/types/event-templates.ts

@@ -1,4 +1,5 @@
 import { EventTemplates } from '@onereach/types-hitl-api';
+
 import { ApiVersionOptions, NoAccountId } from './common';
 
 /* eslint-disable @typescript-eslint/indent */

package/src/types/filters.ts

@@ -1,4 +1,5 @@
 import { Filters } from '@onereach/types-hitl-api';
+
 import { ApiVersionOptions, NoAccountId } from './common';
 
 /* eslint-disable @typescript-eslint/indent */