@or-sdk/hitl 0.34.49 → 0.34.50

package/src/api/Migrations.ts

@@ -1,4 +1,8 @@
 import _ from 'lodash';
+import URI from 'urijs';
+
+import { DEFAULT_OMIT_FIELDS } from '../constants';
+import { ApiVersionOptions } from '../types';
 import {
   GetMigrationsOptions,
   GetMigrationsResponse,
@@ -12,8 +16,8 @@ import {
   SyncDefaultRecordsOptions,
   SyncDefaultRecordsResponse,
 } from '../types/migrations';
+
 import { HITLBase } from './HITLBase';
-import URI from 'urijs';
 
 export class Migrations extends HITLBase {
   protected static readonly MODULE_URL = 'migrations';
@@ -31,6 +35,7 @@ export class Migrations extends HITLBase {
     return this.request({
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -38,7 +43,7 @@ export class Migrations extends HITLBase {
     options: RunMigrationsOptions = {}
   ): Promise<RunMigrationsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version', 'meta']);
+    const params = _.omit(options, [...DEFAULT_OMIT_FIELDS, 'meta']);
     const data = _.pick(options, ['meta']);
 
     return this.request({
@@ -46,34 +51,38 @@ export class Migrations extends HITLBase {
       method: 'POST',
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
-  public static async getRunMigrationsStatus(): Promise<GetRunMigrationsStatusResponse> {
+  public static async getRunMigrationsStatus(options: ApiVersionOptions = {}): Promise<GetRunMigrationsStatusResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.MIGRATIONS_STATUS_URL).href();
 
     return this.request({
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
-  public static async deleteMigrationsTableLock() {
+  public static async deleteMigrationsTableLock(options: ApiVersionOptions = {}) {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.MIGRATIONS_LOCK_URL).href();
 
     return this.request({
       route,
       method: 'DELETE',
+      ...this.getBaseSettings(options),
     });
   }
 
-  public static async getMigrationsInfo(): Promise<GetMigrationsInfoResponse> {
+  public static async getMigrationsInfo(options: ApiVersionOptions = {}): Promise<GetMigrationsInfoResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.MIGRATIONS_INFO_URL).href();
 
     return this.request({
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -86,28 +95,31 @@ export class Migrations extends HITLBase {
       route,
       method: 'GET',
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
-  public static async createTableDefaultRecords(): Promise<CreateDefaultRecordsResponse> {
+  public static async createTableDefaultRecords(options: ApiVersionOptions = {}): Promise<CreateDefaultRecordsResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.DEFAULT_RECORDS_URL).href();
 
     return this.request({
       route,
       method: 'POST',
+      ...this.getBaseSettings(options),
     });
   }
 
   public static async syncTableDefaultRecords(options: SyncDefaultRecordsOptions): Promise<SyncDefaultRecordsResponse> {
     const baseUrl = this.getBaseUrl({});
     const route = new URI(baseUrl).segment(this.DEFAULT_RECORDS_URL).href();
-    const params = _.omit(options, ['version']);
+    const params = _.omit(options, DEFAULT_OMIT_FIELDS);
 
     return this.request({
       route,
       method: 'PUT',
       params,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/RuleGroups.ts

@@ -1,5 +1,6 @@
 import _ from 'lodash';
 
+import { DEFAULT_OMIT_FIELDS } from '../constants';
 import {
   SearchRuleGroupsOptions,
   SearchRuleGroupsResponse,
@@ -8,6 +9,7 @@ import {
   UpdateRuleGroupOptions,
   DeleteRuleGroupOptions,
 } from '../types/rule-groups';
+
 import { HITLBase } from './HITLBase';
 
 export class RuleGroups extends HITLBase {
@@ -17,13 +19,14 @@ export class RuleGroups extends HITLBase {
     options: SearchRuleGroupsOptions = {}
   ): Promise<SearchRuleGroupsResponse | RuleGroup> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version', 'groupIdList', 'accountId']);
+    const params = _.omit(options, [...DEFAULT_OMIT_FIELDS, 'groupIdList', 'accountId']);
     const data = _.pick(options, 'groupIdList');
 
     return this.request({
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -37,6 +40,7 @@ export class RuleGroups extends HITLBase {
       method: 'POST',
       route,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -50,6 +54,7 @@ export class RuleGroups extends HITLBase {
       method: 'PUT',
       route,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -63,6 +68,7 @@ export class RuleGroups extends HITLBase {
       method: 'DELETE',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/SessionEvents.ts

@@ -1,6 +1,7 @@
 import _ from 'lodash';
 import URI from 'urijs';
 
+import { DEFAULT_OMIT_FIELDS } from '../constants';
 import {
   GetNewEventsCountOptions,
   GetNewEventsCountResponse,
@@ -27,12 +28,13 @@ export class SessionEvents extends HITLBase {
     options: GetSessionEventsOptions
   ): Promise<GetSessionEventsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version']);
+    const params = _.omit(options, DEFAULT_OMIT_FIELDS);
 
     return this.request({
       method: 'GET',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -41,12 +43,13 @@ export class SessionEvents extends HITLBase {
   ): Promise<GetBulkSessionsEventsResponse> {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl).segment(this.GET_BULK_EVENTS_URL).href();
-    const params = _.omit(options, ['version']);
+    const params = _.omit(options, DEFAULT_OMIT_FIELDS);
 
     return this.request({
       method: 'GET',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -62,6 +65,7 @@ export class SessionEvents extends HITLBase {
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -71,13 +75,14 @@ export class SessionEvents extends HITLBase {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl).segment(this.GET_EVENTS_COUNT_URL).href();
     const params = _.pick(options, ['userId']);
-    const data = _.omit(options, ['userId', 'version']);
+    const data = _.omit(options, ['userId', ...DEFAULT_OMIT_FIELDS]);
 
     return this.request({
       method: 'POST',
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -87,13 +92,14 @@ export class SessionEvents extends HITLBase {
     const baseUrl = this.getBaseUrl(options);
     const route = new URI(baseUrl).segment(this.SAVE_READ_EVENT_URL).href();
     const params = _.pick(options, ['userId']);
-    const data = _.omit(options, ['userId', 'version']);
+    const data = _.omit(options, ['userId', ...DEFAULT_OMIT_FIELDS]);
 
     return this.request({
       method: 'POST',
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/SessionRelations.ts

@@ -1,6 +1,6 @@
 import _ from 'lodash';
 
-import { HITLBase } from './HITLBase';
+import { DEFAULT_OMIT_FIELDS } from '../constants';
 import {
   GetSessionRelationsOptions,
   GetSessionRelationsResponse,
@@ -9,6 +9,8 @@ import {
   DeleteSessionRelationsOptions,
 } from '../types/session-relations';
 
+import { HITLBase } from './HITLBase';
+
 export class SessionRelations extends HITLBase {
   protected static MODULE_URL = 'session-relations';
 
@@ -16,23 +18,25 @@ export class SessionRelations extends HITLBase {
     options: GetSessionRelationsOptions
   ): Promise<GetSessionRelationsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version']);
+    const params = _.omit(options, DEFAULT_OMIT_FIELDS);
 
     return this.request({
       method: 'GET',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
   public static createSessionRelations(options: CreateSessionRelationsOptions): Promise<CreateSessionRelationsResponse> {
     const route = this.getBaseUrl(options);
-    const data = _.omit(options, ['version']);
+    const data = _.omit(options, DEFAULT_OMIT_FIELDS);
 
     return this.request({
       method: 'POST',
       route,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -41,12 +45,13 @@ export class SessionRelations extends HITLBase {
     options: DeleteSessionRelationsOptions
   ) {
     const route = this.getBaseUrl(options);
-    const data = _.omit(options, ['version']);
+    const data = _.omit(options, DEFAULT_OMIT_FIELDS);
 
     return this.request({
       method: 'DELETE',
       route,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/Sessions.ts

@@ -1,6 +1,7 @@
 import _ from 'lodash';
 import URI from 'urijs';
 
+import { DEFAULT_OMIT_FIELDS } from '../constants';
 import {
   Session,
   GetSessionsOptions,
@@ -25,6 +26,7 @@ import {
   CreateSessionsResponse,
   BulkDeleteSessionsOptions,
 } from '../types/sessions';
+
 import { HITLBase } from './HITLBase';
 
 export class Sessions extends HITLBase {
@@ -45,12 +47,13 @@ export class Sessions extends HITLBase {
     options: GetSessionsOptions = {}
   ): Promise<GetSessionsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version']);
+    const params = _.omit(options, DEFAULT_OMIT_FIELDS);
 
     return this.request({
       method: 'GET',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -65,6 +68,7 @@ export class Sessions extends HITLBase {
       method: 'GET',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -74,13 +78,14 @@ export class Sessions extends HITLBase {
     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 = _.omit(options, ['agentId', ...DEFAULT_OMIT_FIELDS]);
 
     return this.request({
       method: 'POST',
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -93,13 +98,14 @@ export class Sessions extends HITLBase {
       .href();
 
     const params = _.pick(options, ['agentId']);
-    const data = _.omit(options, ['agentId', 'version']);
+    const data = _.omit(options, ['agentId', ...DEFAULT_OMIT_FIELDS]);
 
     return this.request({
       method: 'POST',
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -114,6 +120,7 @@ export class Sessions extends HITLBase {
       method: 'GET',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -126,6 +133,7 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'GET',
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -146,6 +154,7 @@ export class Sessions extends HITLBase {
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -166,6 +175,7 @@ export class Sessions extends HITLBase {
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -183,6 +193,7 @@ export class Sessions extends HITLBase {
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -197,6 +208,7 @@ export class Sessions extends HITLBase {
       method: 'PUT',
       route,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -209,6 +221,7 @@ export class Sessions extends HITLBase {
       method: 'POST',
       route,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -224,6 +237,7 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'POST',
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -240,6 +254,7 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'POST',
       route,
+      ...this.getBaseSettings(options),
     });
   }
   public static async deleteClosedSession(
@@ -250,6 +265,7 @@ export class Sessions extends HITLBase {
     return this.request({
       method: 'DELETE',
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -262,6 +278,7 @@ export class Sessions extends HITLBase {
       method: 'DELETE',
       route,
       params,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/Settings.ts

@@ -1,5 +1,6 @@
 import _ from 'lodash';
 
+import { DEFAULT_OMIT_FIELDS } from '../constants';
 import {
   DeleteSettingOptions,
   GetSettingsOptions,
@@ -7,6 +8,7 @@ import {
   UpdateSettingsOptions,
   UpdateSettingsResponse,
 } from '../types/settings';
+
 import { HITLBase } from './HITLBase';
 
 export class Settings extends HITLBase {
@@ -17,13 +19,14 @@ export class Settings extends HITLBase {
     options: GetSettingsOptions = {}
   ): Promise<GetSettingsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version', 'accountId', 'ignoreRuleTags']);
+    const params = _.omit(options, [...DEFAULT_OMIT_FIELDS, 'accountId', 'ignoreRuleTags']);
     const customHeaders = { [this.IGNORE_RULE_TAGS_HEADER]: `${_.get(options, ['ignoreRuleTags']) || false}` };
 
     return this.request({
       route,
       params,
       customHeaders,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -42,6 +45,7 @@ export class Settings extends HITLBase {
       method: 'PUT',
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -49,12 +53,13 @@ export class Settings extends HITLBase {
     options: DeleteSettingOptions
   ): Promise<GetSettingsResponse> {
     const route = this.getBaseUrl(options);
-    const params = _.omit(options, ['version']);
+    const params = _.omit(options, DEFAULT_OMIT_FIELDS);
 
     return this.request({
       route,
       method: 'DELETE',
       params,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/Tasks.ts

@@ -1,8 +1,9 @@
 import _ from 'lodash';
 
-import { HITLBase } from './HITLBase';
 import { RunTaskOptions } from '../types/tasks';
 
+import { HITLBase } from './HITLBase';
+
 export class Tasks extends HITLBase {
   protected static MODULE_URL = 'tasks';
 
@@ -18,6 +19,7 @@ export class Tasks extends HITLBase {
       route,
       params,
       data,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/api/Versions.ts

@@ -1,9 +1,10 @@
 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';
@@ -15,6 +16,7 @@ export class Versions extends HITLBase {
 
     return this.request({
       route,
+      ...this.getBaseSettings(options),
     });
   }
 
@@ -26,6 +28,7 @@ export class Versions extends HITLBase {
 
     return this.request({
       route,
+      ...this.getBaseSettings(options),
     });
   }
 }

package/src/constants.ts

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

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 {