@or-sdk/hitl 0.28.1 → 0.28.3-beta.590.0

package/src/api/Agents.ts

@@ -1,7 +1,6 @@
 import _ from 'lodash';
 import URI from 'urijs';
 
-import { ApiVersionOptions } from '../types';
 import { GetAgentStatusResponse, AgentStatusOptions } from '../types/agents';
 import { HITLBase } from './HITLBase';
 
@@ -36,11 +35,4 @@ export class Agents extends HITLBase {
       params,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/CannedMessages.ts

@@ -1,7 +1,6 @@
 import _ from 'lodash';
 
 import { HITLBase } from './HITLBase';
-import { ApiVersionOptions } from '../types';
 import {
   CannedMessage,
   GetCannedMessagesOptions,
@@ -67,11 +66,4 @@ export class CannedMessages extends HITLBase {
       params,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/Commands.ts

@@ -1,6 +1,5 @@
 import _ from 'lodash';
 
-import { ApiVersionOptions } from '../types';
 import { ApplyCommandOptions } from '../types/commands';
 import { HITLBase } from './HITLBase';
 
@@ -21,11 +20,4 @@ export class Commands extends HITLBase {
       data,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/Conferences.ts

@@ -1,6 +1,5 @@
 import _ from 'lodash';
 
-import { ApiVersionOptions } from '../types';
 import {
   GetConferenceMembersOptions,
   GetConferenceMembersResponse,
@@ -58,11 +57,4 @@ export class Conferences extends HITLBase {
       params,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/EventTemplates.ts

@@ -1,6 +1,5 @@
 import _ from 'lodash';
 
-import { ApiVersionOptions } from '../types';
 import {
   GetEventTemplatesOptions,
   GetEventTemplatesResponse,
@@ -65,11 +64,4 @@ export class EventTemplates extends HITLBase {
       params,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/Filters.ts

@@ -1,7 +1,6 @@
 import _ from 'lodash';
 
 import { HITLBase } from './HITLBase';
-import { ApiVersionOptions } from '../types';
 import {
   Filter,
   GetFiltersOptions,
@@ -69,11 +68,4 @@ export class Filters extends HITLBase {
       params,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/HITLBase.ts

@@ -3,6 +3,8 @@ import { Request, BaseUrlOptions } from '../types';
 export class HITLBase {
   protected static readonly BASE_URL = '/api/v{version}/{module}';
   protected static readonly LATEST_VERSION = 1;
+  /** This variable should be overridden in child classes */
+  protected static readonly MODULE_URL: string = '';
 
   protected static request: Request;
 
@@ -24,7 +26,11 @@ export class HITLBase {
   }
 
   protected static getBaseUrl(options: BaseUrlOptions): string {
-    const { version = this.LATEST_VERSION, module } = options;
+    const {
+      version = this.LATEST_VERSION,
+      module = this.MODULE_URL,
+    } = options;
+
     const content = {
       version: version.toString(),
       module,

package/src/api/Listeners.ts

@@ -2,7 +2,6 @@ import _ from 'lodash';
 import URI from 'urijs';
 
 import { HITLBase } from './HITLBase';
-import { ApiVersionOptions } from '../types';
 import {
   Listener,
   GetListenersOptions,
@@ -66,11 +65,4 @@ export class Listeners extends HITLBase {
       route,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/Migrations.ts

@@ -1,5 +1,4 @@
 import _ from 'lodash';
-import { ApiVersionOptions } from '../types';
 import {
   GetMigrationsOptions,
   GetMigrationsResponse,
@@ -35,11 +34,4 @@ export class Migrations extends HITLBase {
       params,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/RuleGroups.ts

@@ -1,6 +1,5 @@
 import _ from 'lodash';
 
-import { ApiVersionOptions } from '../types';
 import {
   SearchRuleGroupsOptions,
   SearchRuleGroupsResponse,
@@ -66,11 +65,4 @@ export class RuleGroups extends HITLBase {
       params,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/SessionEvents.ts

@@ -2,10 +2,11 @@ import _ from 'lodash';
 import URI from 'urijs';
 
 import { HITLBase } from './HITLBase';
-import { ApiVersionOptions } from '../types';
 import {
   GetSessionEventsOptions,
   GetSessionEventsResponse,
+  AddEventsOptions,
+  AddEventsResponse,
 } from '../types/session-events';
 import {
   GetNewEventsCountOptions,
@@ -31,6 +32,21 @@ export class SessionEvents extends HITLBase {
     });
   }
 
+  public static addEvents(
+    options: AddEventsOptions
+  ): Promise<AddEventsResponse> {
+    const route = this.getBaseUrl(options);
+    const params = _.pick(options, ['sessionId']);
+    const data = _.pick(options, ['events']);
+
+    return this.request({
+      method: 'POST',
+      route,
+      params,
+      data,
+    });
+  }
+
   public static async getNewEventsCount(
     options: GetNewEventsCountOptions
   ): Promise<GetNewEventsCountResponse> {
@@ -62,11 +78,4 @@ export class SessionEvents extends HITLBase {
       data,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/api/Sessions.ts

@@ -1,28 +1,191 @@
+import _ from 'lodash';
 import URI from 'urijs';
 
-import { ApiVersionOptions } from '../types';
-import { GetInitTriggersResponse, InitTriggersOptions } from '../types/sessions';
+import {
+  ClaimSessionByAgentOptions,
+  CloseSessionOptions,
+  GetInitTriggersOptions,
+  GetInitTriggersResponse,
+  GetQueueSessionOptions,
+  GetQueueSessionResponse,
+  GetSessionsOptions,
+  GetSessionsResponse,
+  SearchSessionsOptions,
+  SearchSessionsResponse,
+  Session,
+  StartConversationOptions,
+  TransferToBotOptions,
+  UpdateSessionOptions,
+  SearchSessionsWithContactsOptions,
+  SearchSessionsWithContactsResponse,
+} from '../types/sessions';
 import { HITLBase } from './HITLBase';
 
 export class Sessions extends HITLBase {
   protected static MODULE_URL = 'sessions';
-  protected static INIT_TRIGGERS_URL = 'triggers';
+
+  protected static SEARCH_URL = 'search';
+  protected static SEARCH_WITH_CONTACTS_URL = 'search-with-contacts';
+  protected static GET_TRIGGERS_URL = 'triggers';
+  protected static GET_QUEUE_SESSION_URL = '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';
+
+  public static async getSessions(
+    options: GetSessionsOptions = {}
+  ): Promise<GetSessionsResponse> {
+    const route = this.getBaseUrl(options);
+    const params = _.omit(options, ['version']);
+
+    return this.request({
+      method: 'GET',
+      route,
+      params,
+    });
+  }
+
+  public static async searchSessions(
+    options: SearchSessionsOptions = {}
+  ): Promise<SearchSessionsResponse> {
+    const baseUrl = this.getBaseUrl(options);
+    const route = new URI(baseUrl).segment(this.SEARCH_URL).href();
+    const params = _.omit(options, ['version']);
+
+    return this.request({
+      method: 'POST',
+      route,
+      params,
+    });
+  }
+
+  public static async searchSessionsWithContacts(
+    options: SearchSessionsWithContactsOptions = {}
+  ): Promise<SearchSessionsWithContactsResponse> {
+    const baseUrl = this.getBaseUrl(options);
+    const route = new URI(baseUrl)
+      .segment(this.SEARCH_WITH_CONTACTS_URL)
+      .href();
+
+    const params = _.omit(options, ['version']);
+    return this.request({
+      method: 'POST',
+      route,
+      params,
+    });
+  }
+
+  public static async getQueueSession(
+    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,
+    });
+  }
 
   public static async getSessionInitTriggers(
-    options: InitTriggersOptions = {}
+    options: GetInitTriggersOptions = {}
   ): Promise<GetInitTriggersResponse> {
     const baseUrl = this.getBaseUrl(options);
-    const route = new URI(baseUrl).segment(this.INIT_TRIGGERS_URL).href();
+    const route = new URI(baseUrl).segment(this.GET_TRIGGERS_URL).href();
+
+    return this.request({
+      method: 'GET',
+      route,
+    });
+  }
+
+  public static async claimSessionByAgent(
+    options: ClaimSessionByAgentOptions
+  ): Promise<Session> {
+    const baseUrl = this.getBaseUrl(options);
+    const route = new URI(baseUrl)
+      .segment(options.sessionId)
+      .segment(this.CLAIM_URL)
+      .href();
+
+    const params = _.pick(options, ['claimBy']);
+    const data = _.pick(options, ['params']);
+
+    return this.request({
+      method: 'POST',
+      route,
+      params,
+      data,
+    });
+  }
+
+  public static async transferToBot(
+    options: TransferToBotOptions
+  ): Promise<Session> {
+    const baseUrl = this.getBaseUrl(options);
+    const route = new URI(baseUrl)
+      .segment(options.sessionId)
+      .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,
+    });
+  }
+
+  public static async startConversation(
+    options: StartConversationOptions
+  ): Promise<Session> {
+    const baseUrl = this.getBaseUrl(options);
+    const route = new URI(baseUrl).segment(this.TRANSFER_TO_BOT_URL).href();
+
+    const params = _.pick(options, ['contactId', 'triggerId']);
+    const data = _.pick(options, ['params']);
+
+    return this.request({
+      method: 'POST',
+      route,
+      params,
+      data,
+    });
+  }
+
+  public static async updateSession(
+    options: UpdateSessionOptions
+  ): Promise<Session> {
+    const baseUrl = this.getBaseUrl(options);
+    const route = new URI(baseUrl).segment(options.sessionId).href();
 
+    const data = _.pick(options, ['tags']);
     return this.request({
+      method: 'PUT',
       route,
+      data,
     });
   }
 
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
+  public static async closeSession(
+    options: CloseSessionOptions
+  ): Promise<Session> {
+    const baseUrl = this.getBaseUrl(options);
+    const route = new URI(baseUrl)
+      .segment(options.sessionId)
+      .segment(this.CLOSE_URL)
+      .href();
+
+    return this.request({
+      method: 'POST',
+      route,
     });
   }
 }

package/src/api/Settings.ts

@@ -1,6 +1,5 @@
 import _ from 'lodash';
 
-import { ApiVersionOptions } from '../types';
 import {
   GetSettingsOptions,
   GetSettingsResponse,
@@ -38,11 +37,4 @@ export class Settings extends HITLBase {
       data,
     });
   }
-
-  protected static getBaseUrl(options: ApiVersionOptions): string {
-    return HITLBase.getBaseUrl({
-      ...options,
-      module: this.MODULE_URL,
-    });
-  }
 }

package/src/types/common.ts

@@ -1,5 +1,12 @@
 import { Token, CalApiParams } from '@or-sdk/base';
-import { APP_ERROR_TYPE } from '@onereach/types-hitl-api';
+import {
+  AGENT_STATUS,
+  APP_ERROR_TYPE,
+  BROADCAST_EVENTS,
+  CALL_MEMBER_STATUS,
+  CALL_MEMBER_TYPE,
+  SESSION_STATUS,
+} from '@onereach/types-hitl-api';
 
 export type HITLConfig = {
   readonly token: Token;
@@ -16,7 +23,7 @@ export interface ApiVersionOptions {
 }
 
 export interface BaseUrlOptions extends ApiVersionOptions {
-  readonly module: string;
+  readonly module?: string;
 }
 
 export interface IAppError {
@@ -28,4 +35,11 @@ export interface IAppError {
   readonly timestamp: number;
 }
 
-export { APP_ERROR_TYPE };
+export {
+  AGENT_STATUS,
+  APP_ERROR_TYPE,
+  BROADCAST_EVENTS,
+  CALL_MEMBER_STATUS,
+  CALL_MEMBER_TYPE,
+  SESSION_STATUS,
+};

package/src/types/read-events.ts

@@ -5,10 +5,10 @@ import { ApiVersionOptions, NoAccountId } from './common';
 export type ReadEvent = ReadEvents.IReadEvent;
 
 export type GetNewEventsCountOptions = ApiVersionOptions
-  & NoAccountId<ReadEvents.IGetNewEventsAmountQuery>
-  & ReadEvents.IGetNewEventsAmountBody;
+  & NoAccountId<ReadEvents.IGetNewEventsCountQuery>
+  & ReadEvents.IGetNewEventsCountBody;
 export type GetNewEventsCountResponse
-  = ReadEvents.IGetNewEventsAmountResponse;
+  = ReadEvents.IGetNewEventsCountResponse;
 
 export type SaveLastReadEventOptions = ApiVersionOptions
   & NoAccountId<ReadEvents.ISaveLastReadEventQuery>

package/src/types/session-events.ts

@@ -3,8 +3,13 @@ import { ApiVersionOptions, NoAccountId } from './common';
 
 /* eslint-disable @typescript-eslint/indent */
 export type SessionEvent = SessionEvents.ISessionEvent;
+
 export type GetSessionEventsOptions = ApiVersionOptions
   & NoAccountId<SessionEvents.IGetSessionEventsQuery>;
 export type GetSessionEventsResponse
   = SessionEvents.IGetSessionEventsResponse;
 
+export type AddEventsOptions = ApiVersionOptions
+  & NoAccountId<SessionEvents.IAddEventsBySessionIdQuery>
+  & SessionEvents.IAddEventsBySessionIdBody;
+export type AddEventsResponse = SessionEvents.IAddEventsBySessionIdResponse;

package/src/types/sessions.ts

@@ -1,5 +1,47 @@
-import { Sessions } from '@onereach/types-hitl-api';
-import { ApiVersionOptions } from './common';
+import { ISessionId, Sessions } from '@onereach/types-hitl-api';
+import { ApiVersionOptions, NoAccountId } from './common';
 
+export type Session = Sessions.ISession;
+export type TransferToBot = Sessions.ITransferToBot;
+export type Command = Sessions.ICommand;
+
+/* eslint-disable @typescript-eslint/indent */
+export type GetSessionsOptions = ApiVersionOptions
+  & NoAccountId<Sessions.IGetSessionsQuery>;
+export type GetSessionsResponse = Session | Sessions.IGetSessionsResponse;
+
+export type SearchSessionsOptions = ApiVersionOptions
+  & NoAccountId<Sessions.ISearchSessionsQuery>;
+export type SearchSessionsResponse = Sessions.IGetSessionsResponse;
+
+export type SearchSessionsWithContactsOptions = ApiVersionOptions
+  & NoAccountId<Sessions.ISearchSessionsWithContactsQuery>;
+export type SearchSessionsWithContactsResponse
+  = Sessions.ISearchSessionsWithContactsResponse;
+
+export type GetQueueSessionOptions = ApiVersionOptions
+  & NoAccountId<Sessions.IGetQueueSessionQuery>;
+export type GetQueueSessionResponse = Sessions.IGetQueueSessionResponse;
+
+export type ClaimSessionByAgentOptions = ApiVersionOptions
+  & ISessionId
+  & NoAccountId<Sessions.IClaimSessionQuery>
+  & Sessions.IClaimSessionBody;
+
+export type TransferToBotOptions = ApiVersionOptions
+  & ISessionId
+  & NoAccountId<Sessions.ITransferToBotQuery>
+  & Sessions.ITransferToBotBody;
+
+export type StartConversationOptions = ApiVersionOptions
+  & Sessions.IInitConversationQuery
+  & Sessions.IInitConversationBody;
+
+export type UpdateSessionOptions = ApiVersionOptions
+  & ISessionId
+  & Sessions.IUpdateSessionBody;
+
+export type CloseSessionOptions = ApiVersionOptions & ISessionId;
+
+export type GetInitTriggersOptions = ApiVersionOptions;
 export type GetInitTriggersResponse = Sessions.IGetInitTriggersResponse;
-export type InitTriggersOptions = ApiVersionOptions;