@or-sdk/hitl 0.34.56 → 0.34.57-beta.3229.0

package/src/api/EventTemplates.ts

@@ -15,6 +15,10 @@ import { HITLBase } from './HITLBase';
 export class EventTemplates extends HITLBase {
   protected static readonly MODULE_URL = 'event-templates';
 
+  /**
+   * @description Get Event templates
+   * @param options
+   */
   public static async getEventTemplates(
     options: GetEventTemplatesOptions = {}
   ): Promise<GetEventTemplatesResponse | EventTemplate> {
@@ -29,6 +33,10 @@ export class EventTemplates extends HITLBase {
     });
   }
 
+  /**
+   * @description Create Event template
+   * @param options
+   */
   public static async createEventTemplate(
     options: CreateEventTemplateOptions
   ): Promise<EventTemplate> {
@@ -46,6 +54,10 @@ export class EventTemplates extends HITLBase {
     });
   }
 
+  /**
+   * @description Update Event template
+   * @param options
+   */
   public static async updateEventTemplate(
     options: UpdateEventTemplateOptions
   ): Promise<EventTemplate> {
@@ -60,6 +72,10 @@ export class EventTemplates extends HITLBase {
     });
   }
 
+  /**
+   * @description Delete Event template
+   * @param options
+   */
   public static async deleteEventTemplate(
     options: DeleteEventTemplateOptions
   ): Promise<void> {

package/src/api/Filters.ts

@@ -38,6 +38,10 @@ export class Filters extends HITLBase {
   ];
   protected static FILTER_VERSION_FIELD = 'filterVersion';
 
+  /**
+   * @description Get Conversation view filters list
+   * @param options
+   */
   public static getFilters(options: GetFiltersOptionsV1): Promise<GetFiltersResponseV1>;
   public static getFilters(options: GetFiltersOptions): Promise<GetFiltersResponse>;
   public static getFilters(
@@ -54,6 +58,11 @@ export class Filters extends HITLBase {
     });
   }
 
+
+  /**
+   * @description Bulk get Conversation view filters list ignoring userId for personal filters
+   * @param options
+   */
   public static bulkGetFilters(options: BulkGetFiltersOptionsV1): Promise<GetFiltersResponseV1>;
   public static bulkGetFilters(options: BulkGetFiltersOptions): Promise<GetFiltersResponse>;
   public static bulkGetFilters(
@@ -71,6 +80,10 @@ export class Filters extends HITLBase {
     });
   }
 
+  /**
+   * @description Create Conversation view filter
+   * @param options
+   */
   public static createFilter(options: CreateFilterOptionsV1): Promise<FilterV1>;
   public static createFilter(options: CreateFilterOptions): Promise<Filter>;
   public static createFilter(options: CreateFilterOptions) {
@@ -90,6 +103,10 @@ export class Filters extends HITLBase {
     });
   }
 
+  /**
+   * @description Update Conversation view filter
+   * @param options
+   */
   public static updateFilter(options: UpdateFilterOptionsV1): Promise<FilterV1>;
   public static updateFilter(options: UpdateFilterOptions): Promise<Filter>;
   public static updateFilter(options: UpdateFilterOptions) {
@@ -107,6 +124,10 @@ export class Filters extends HITLBase {
     });
   }
 
+  /**
+   * @description Bulk update Conversation view filters ignoring userId for personal filters
+   * @param options
+   */
   public static bulkUpdateFilters(options: BulkUpdateFiltersOptionsV1): Promise<BulkUpdateFiltersResponseV1>;
   public static bulkUpdateFilters(options: BulkUpdateFiltersOptions): Promise<BulkUpdateFiltersResponse>;
   public static bulkUpdateFilters(options: BulkUpdateFiltersOptionsV1) {
@@ -129,6 +150,10 @@ export class Filters extends HITLBase {
     });
   }
 
+  /**
+   * @description Delete Conversation view filter
+   * @param options
+   */
   public static deleteFilter(options: DeleteFilterOptionsV1): Promise<GetFiltersResponseV1 | FilterV1>;
   public static deleteFilter(options: DeleteFilterOptions): Promise<GetFiltersResponse | Filter>;
   public static deleteFilter(

package/src/api/Helpers.ts

@@ -9,6 +9,10 @@ export class Helpers extends HITLBase {
   protected static MODULE_URL = 'helpers';
   protected static CLEAN_CONTACTS = 'clean-contact-duplicates';
 
+  /**
+   * @description Delete Contact duplicates (Tables-based contacts v1)
+   * @param options
+   */
   public static async deleteContactDuplicates(
     options: ApiVersionOptions
   ): Promise<CleanUpDuplicatesResponse> {

package/src/api/Listeners.ts

@@ -14,9 +14,18 @@ import {
 
 import { HITLBase } from './HITLBase';
 
+/**
+ * HitL events Listener is an object describing a real-time Evnets callback -
+ * either an active WebSocket in Agent UI, flow event subscription callback or a
+ * mobile application push notification "callbacks"
+ */
 export class Listeners extends HITLBase {
   protected static MODULE_URL = 'listeners';
 
+  /**
+   * @description Get a list of HitL event listeners
+   * @param options
+   */
   public static async getListeners(
     options: GetListenersOptions = {}
   ): Promise<GetListenersResponse> {
@@ -31,6 +40,10 @@ export class Listeners extends HITLBase {
     });
   }
 
+  /**
+   * @description Get HitL event listeners by id
+   * @param options
+   */
   public static async getListenerById(
     options: GetListenerByIdOptions
   ): Promise<GetListenersResponse> {
@@ -46,6 +59,10 @@ export class Listeners extends HITLBase {
     });
   }
 
+  /**
+   * @description Create HitL event listener
+   * @param options
+   */
   public static async createListener(
     options: CreateListenersOptions
   ): Promise<Listener> {
@@ -60,6 +77,10 @@ export class Listeners extends HITLBase {
     });
   }
 
+  /**
+   * @description Update HitL event listener
+   * @param options
+   */
   public static async updateListener(
     options: UpdateListenersOptions
   ): Promise<Listener> {
@@ -75,6 +96,10 @@ export class Listeners extends HITLBase {
     });
   }
 
+  /**
+   * @description Delete HitL event listener
+   * @param options
+   */
   public static async deleteListener(
     options: DeleteListenersOptions
   ): Promise<void> {

package/src/api/Migrations.ts

@@ -26,6 +26,10 @@ export class Migrations extends HITLBase {
   protected static MIGRATIONS_LOCK_URL = 'lock';
   protected static MIGRATIONS_STATUS_URL = 'status';
 
+  /**
+   * @description Get list of pending migrations
+   * @param options
+   */
   public static async getListOfMigrations(
     options: GetMigrationsOptions = {}
   ): Promise<GetMigrationsResponse> {
@@ -39,6 +43,10 @@ export class Migrations extends HITLBase {
     });
   }
 
+  /**
+   * @description Run migrations
+   * @param options
+   */
   public static async runAllMigrations(
     options: RunMigrationsOptions = {}
   ): Promise<RunMigrationsResponse> {
@@ -55,6 +63,10 @@ export class Migrations extends HITLBase {
     });
   }
 
+  /**
+   * @description Get status of running migrations
+   * @param options
+   */
   public static async getRunMigrationsStatus(options: ApiVersionOptions = {}): Promise<GetRunMigrationsStatusResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.MIGRATIONS_STATUS_URL).href();
@@ -65,6 +77,10 @@ export class Migrations extends HITLBase {
     });
   }
 
+  /**
+   * @description Delete migrations table lock (set during migration runs)
+   * @param options
+   */
   public static async deleteMigrationsTableLock(options: ApiVersionOptions = {}) {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.MIGRATIONS_LOCK_URL).href();
@@ -76,6 +92,10 @@ export class Migrations extends HITLBase {
     });
   }
 
+  /**
+   * @description Get migrations info about compatibility with UI versions
+   * @param options
+   */
   public static async getMigrationsInfo(options: ApiVersionOptions = {}): Promise<GetMigrationsInfoResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.MIGRATIONS_INFO_URL).href();
@@ -86,6 +106,10 @@ export class Migrations extends HITLBase {
     });
   }
 
+  /**
+   * @description Get default records for some tables (settings, filters, eventTemplates, rule_groups)
+   * @param options
+   */
   public static async getTableDefaultRecords(options: GetDefaultRecordsOptions): Promise<GetDefaultRecordsResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.DEFAULT_RECORDS_URL).href();
@@ -99,6 +123,10 @@ export class Migrations extends HITLBase {
     });
   }
 
+  /**
+   * @description Add default records for some tables (settings, filters, event_templates, rule_groups)
+   * @param options
+   */
   public static async createTableDefaultRecords(options: ApiVersionOptions = {}): Promise<CreateDefaultRecordsResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.DEFAULT_RECORDS_URL).href();
@@ -110,6 +138,10 @@ export class Migrations extends HITLBase {
     });
   }
 
+  /**
+   * @description Sync default records for some tables (settings, filters, eventTemplates, rule_groups)
+   * @param options
+   */
   public static async syncTableDefaultRecords(options: SyncDefaultRecordsOptions): Promise<SyncDefaultRecordsResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.DEFAULT_RECORDS_URL).href();

package/src/api/RuleGroups.ts

@@ -15,6 +15,10 @@ import { HITLBase } from './HITLBase';
 export class RuleGroups extends HITLBase {
   protected static MODULE_URL = 'rule-groups';
 
+  /**
+   * @description Get/search Rule Groups
+   * @param options
+   */
   public static searchRuleGroups(
     options: SearchRuleGroupsOptions = {}
   ): Promise<SearchRuleGroupsResponse | RuleGroup> {
@@ -30,6 +34,10 @@ export class RuleGroups extends HITLBase {
     });
   }
 
+  /**
+   * @description Create Rule Group
+   * @param options
+   */
   public static createRuleGroup(
     options: CreateRuleGroupOptions
   ): Promise<RuleGroup> {
@@ -44,6 +52,10 @@ export class RuleGroups extends HITLBase {
     });
   }
 
+  /**
+   * @description Update Rule Group
+   * @param options
+   */
   public static updateRuleGroup(
     options: UpdateRuleGroupOptions
   ): Promise<RuleGroup> {
@@ -58,6 +70,10 @@ export class RuleGroups extends HITLBase {
     });
   }
 
+  /**
+   * @description Delete Rule Group
+   * @param options
+   */
   public static deleteRuleGroup(
     options: DeleteRuleGroupOptions
   ): Promise<void> {

package/src/api/SessionEvents.ts

@@ -24,6 +24,10 @@ export class SessionEvents extends HITLBase {
   protected static GET_EVENTS_COUNT_URL = 'get-new-events';
   protected static SAVE_READ_EVENT_URL = 'save-read-event';
 
+  /**
+   * @description Get Event list of a HitL Session
+   * @param options
+   */
   public static async getSessionEventsList(
     options: GetSessionEventsOptions
   ): Promise<GetSessionEventsResponse> {
@@ -38,6 +42,10 @@ export class SessionEvents extends HITLBase {
     });
   }
 
+  /**
+   * @description Get Events of multiple HitL Sessions
+   * @param options
+   */
   public static async getBulkSessionEventsList(
     options: GetBulkSessionEventsOptions
   ): Promise<GetBulkSessionsEventsResponse> {
@@ -53,12 +61,16 @@ export class SessionEvents extends HITLBase {
     });
   }
 
+  /**
+   * @description Add new Event to HitL Session
+   * @param options
+   */
   public static addEvents(
     options: AddEventsOptions
   ): Promise<AddEventsResponse> {
     const route = this.getBaseUrl(options);
     const params = _.pick(options, ['sessionId']);
-    const data = _.pick(options, ['events']);
+    const data = _.pick(options, ['Event']);
 
     return this.request({
       method: 'POST',
@@ -69,6 +81,10 @@ export class SessionEvents extends HITLBase {
     });
   }
 
+  /**
+   * @description Get unread Event count for an Agent
+   * @param options
+   */
   public static async getNewEventsCount(
     options: GetNewEventsCountOptions
   ): Promise<GetNewEventsCountResponse> {
@@ -86,6 +102,10 @@ export class SessionEvents extends HITLBase {
     });
   }
 
+  /**
+   * @description Save last read Event info (event id and timestamp) for a Agent and HitL Session
+   * @param options
+   */
   public static async saveReadEventByUserId(
     options: SaveLastReadEventOptions
   ): Promise<void> {

package/src/api/SessionRelations.ts

@@ -14,6 +14,10 @@ import { HITLBase } from './HITLBase';
 export class SessionRelations extends HITLBase {
   protected static MODULE_URL = 'session-relations';
 
+  /**
+   * @description Get a list of HitL Session Relations
+   * @param options
+   */
   public static getSessionRelations(
     options: GetSessionRelationsOptions
   ): Promise<GetSessionRelationsResponse> {
@@ -28,6 +32,11 @@ export class SessionRelations extends HITLBase {
     });
   }
 
+  /**
+   * @description Create HitL Session Relations
+   * @param options
+   */
+
   public static createSessionRelations(options: CreateSessionRelationsOptions): Promise<CreateSessionRelationsResponse> {
     const route = this.getBaseUrl(options);
     const data = _.omit(options, DEFAULT_OMIT_FIELDS);
@@ -40,7 +49,10 @@ export class SessionRelations extends HITLBase {
     });
   }
 
-
+  /**
+   * @description Delete HitL Session Relations
+   * @param options
+   */
   public static deleteSessionRelations(
     options: DeleteSessionRelationsOptions
   ) {

package/src/api/Sessions.ts

@@ -43,6 +43,10 @@ export class Sessions extends HITLBase {
   protected static CLOSE_URL = 'close';
   protected static REOPEN_URL = 'reopen';
 
+  /**
+   * @description Get HitL Sessions
+   * @param options
+   */
   public static async getSessions(
     options: GetSessionsOptions = {}
   ): Promise<GetSessionsResponse> {
@@ -57,6 +61,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Get HitL Session by id
+   * @param options
+   */
   public static async getSessionById(
     options: GetSessionByIdOptions
   ): Promise<Session> {
@@ -72,6 +80,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Search HitL Sessions
+   * @param options
+   */
   public static async searchSessions(
     options: SearchSessionsOptions = {}
   ): Promise<SearchSessionsResponse> {
@@ -89,6 +101,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Search HitL Sessions and return a list of found Sessions with their Contacts
+   * @param options
+   */
   public static async searchSessionsWithContacts(
     options: SearchSessionsWithContactsOptions = {}
   ): Promise<SearchSessionsWithContactsResponse> {
@@ -109,6 +125,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Get next HitL Session in the NEEDS_ACTION status
+   * @param options
+   */
   public static async getQueueSession(
     options: GetQueueSessionOptions
   ): Promise<GetQueueSessionResponse> {
@@ -124,6 +144,11 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @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> {
@@ -137,6 +162,12 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @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
   ): Promise<Session> {
@@ -158,6 +189,12 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @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
   ): Promise<Session> {
@@ -179,6 +216,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Start new HitL Session
+   * @param options
+   */
   public static async startConversation(
     options: StartConversationOptions
   ): Promise<Session> {
@@ -197,6 +238,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Update HitL Session
+   * @param options
+   */
   public static async updateSession(
     options: UpdateSessionOptions
   ): Promise<Session> {
@@ -212,6 +257,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Create HitL Session
+   * @param options
+   */
   public static async createSessions(
     options: CreateSessionsOptions
   ): Promise<CreateSessionsResponse> {
@@ -225,6 +274,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Close HitL Session
+   * @param options
+   */
   public static async closeSession(
     options: CloseSessionOptions
   ): Promise<Session> {
@@ -241,7 +294,10 @@ export class Sessions extends HITLBase {
     });
   }
 
-
+  /**
+   * @description Reopen closed HitL Session
+   * @param options
+   */
   public static async reopenSession(
     options: ReopenSessionOptions
   ): Promise<Session> {
@@ -257,6 +313,11 @@ export class Sessions extends HITLBase {
       ...this.getBaseSettings(options),
     });
   }
+
+  /**
+   * @description Delete closed HitL Session
+   * @param options
+   */
   public static async deleteClosedSession(
     options: DeleteClosedSessionOptions
   ) {
@@ -269,6 +330,10 @@ export class Sessions extends HITLBase {
     });
   }
 
+  /**
+   * @description Delete HitL Sessions in bulk
+   * @param options
+   */
   public static async buldDeleteSessions(
     options: BulkDeleteSessionsOptions
   ) {

package/src/api/Settings.ts

@@ -19,6 +19,10 @@ export class Settings extends HITLBase {
   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 = {}
   ): Promise<GetSettingsResponse> {
@@ -34,6 +38,10 @@ export class Settings extends HITLBase {
     });
   }
 
+  /**
+   * @description Get contact book info setting using agent rule groups for triggers
+   * @param options
+   */
   public static async getContactBookInfoSetting(
     options: GetContactBookInfoSettingOptions = {}
   ): Promise<SettingsType> {
@@ -48,6 +56,10 @@ export class Settings extends HITLBase {
     });
   }
 
+  /**
+   * @description Update setting
+   * @param options
+   */
   public static async updateSettings(
     options: UpdateSettingsOptions
   ): Promise<UpdateSettingsResponse> {
@@ -67,6 +79,11 @@ export class Settings extends HITLBase {
     });
   }
 
+  /**
+   * @description Delete setting
+   * @param options
+   */
+
   public static async deleteSetting(
     options: DeleteSettingOptions
   ): Promise<GetSettingsResponse> {

package/src/api/Tasks.ts

@@ -6,7 +6,10 @@ import { HITLBase } from './HITLBase';
 
 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
   ): Promise<void> {

package/src/api/Versions.ts

@@ -9,6 +9,10 @@ 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> {
@@ -20,6 +24,10 @@ export class Versions extends HITLBase {
     });
   }
 
+  /**
+   * @description Get version info
+   * @param options
+   */
   public static async getVersionInfo(
     options: ApiVersionOptions
   ): Promise<GetVersionInfoResponse> {