@onereach/types-hitl-api 0.0.32-rc.1 → 0.0.32-rc.10

package/dist/types/constants/api.d.ts

@@ -40,6 +40,10 @@ export declare enum APP_ERROR_TYPE {
 /** These events are received by clients, usually using WebSocket */
 export declare const BROADCAST_EVENTS: {
     ADD_EVENTS: string;
-    CLOSE_HITL_SESSION: string;
-    UPSERT_HITL_SESSION: string;
+    CLOSE_SESSION: string;
+    UPSERT_SESSION: string;
+    NOTIFY_AGENTS: string;
+    MULTI_ACTION: string;
+    START_CALL: string;
+    UPSERT_CONFERENCE_MEMBER: string;
 };

package/dist/types/constants/api.js

@@ -48,7 +48,11 @@ var APP_ERROR_TYPE;
 /** These events are received by clients, usually using WebSocket */
 exports.BROADCAST_EVENTS = {
     ADD_EVENTS: 'ADD_EVENTS',
-    CLOSE_HITL_SESSION: 'CLOSE_HITL_SESSION',
-    UPSERT_HITL_SESSION: 'UPSERT_HITL_SESSION',
+    CLOSE_SESSION: 'CLOSE_SESSION',
+    UPSERT_SESSION: 'UPSERT_SESSION',
+    NOTIFY_AGENTS: 'NOTIFY_AGENTS',
+    MULTI_ACTION: 'MULTI_ACTION',
+    START_CALL: 'START_CALL',
+    UPSERT_CONFERENCE_MEMBER: 'UPSERT_CONFERENCE_MEMBER',
 };
 //# sourceMappingURL=api.js.map

package/dist/types/constants/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/constants/api.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,6BAAa,CAAA;IACb,mCAAmB,CAAA;AACrB,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAED,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;AACnB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAED,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;IACvB,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,qCAAe,CAAA;IACf,qCAAe,CAAA;IACf,mCAAa,CAAA;IACb,qDAA+B,CAAA;IAC/B,mDAA6B,CAAA;IAC7B,yCAAmB,CAAA;AACrB,CAAC,EAbW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAa7B;AAED,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,6CAAyB,CAAA;AAC3B,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B;AAED,IAAY,cASX;AATD,WAAY,cAAc;IACxB,uCAAqB,CAAA;IACrB,yCAAuB,CAAA;IACvB,6CAA2B,CAAA;IAC3B,2CAAyB,CAAA;IACzB,uDAAqC,CAAA;IACrC,uDAAqC,CAAA;IACrC,mEAAiD,CAAA;IACjD,6DAA2C,CAAA;AAC7C,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB;AAED,oEAAoE;AACvD,QAAA,gBAAgB,GAAG;IAC9B,UAAU,EAAE,YAAY;IACxB,kBAAkB,EAAE,oBAAoB;IACxC,mBAAmB,EAAE,qBAAqB;CAC3C,CAAC"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/constants/api.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,6BAAa,CAAA;IACb,mCAAmB,CAAA;AACrB,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAED,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,qCAAmB,CAAA;IACnB,mCAAiB,CAAA;AACnB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAED,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;IACvB,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,qCAAe,CAAA;IACf,qCAAe,CAAA;IACf,mCAAa,CAAA;IACb,qDAA+B,CAAA;IAC/B,mDAA6B,CAAA;IAC7B,yCAAmB,CAAA;AACrB,CAAC,EAbW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAa7B;AAED,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,6CAAyB,CAAA;AAC3B,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B;AAED,IAAY,cASX;AATD,WAAY,cAAc;IACxB,uCAAqB,CAAA;IACrB,yCAAuB,CAAA;IACvB,6CAA2B,CAAA;IAC3B,2CAAyB,CAAA;IACzB,uDAAqC,CAAA;IACrC,uDAAqC,CAAA;IACrC,mEAAiD,CAAA;IACjD,6DAA2C,CAAA;AAC7C,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB;AAED,oEAAoE;AACvD,QAAA,gBAAgB,GAAG;IAC9B,UAAU,EAAE,YAAY;IACxB,aAAa,EAAE,eAAe;IAC9B,cAAc,EAAE,gBAAgB;IAChC,aAAa,EAAE,eAAe;IAC9B,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,wBAAwB,EAAE,0BAA0B;CACrD,CAAC"}

package/dist/types/interfaces/api/commands.d.ts

@@ -0,0 +1,7 @@
+export interface IApplyCommandQuery {
+    readonly command: string;
+    readonly sessionId: string;
+}
+export interface IApplyCommandBody {
+    readonly data?: object;
+}

package/dist/types/interfaces/api/commands.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=commands.js.map

package/dist/types/interfaces/api/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../src/interfaces/api/commands.ts"],"names":[],"mappings":""}

package/dist/types/interfaces/api/common.d.ts

@@ -15,10 +15,26 @@ export interface ITargetAccountId {
 export interface ITargetUserId {
     readonly agentId?: string;
 }
+/** Common names for a property that references session */
+export declare type ITargetSessionId = Partial<ISessionId>;
+export interface ISessionId {
+    readonly sessionId: string;
+}
 export interface IPageOptions {
     readonly gt?: string;
     readonly gte?: string;
     readonly lt?: string;
     readonly lte?: string;
-    readonly uniqueId?: string;
+    readonly nextId?: string;
+}
+/**
+ * Wrap array responses in "data" property,
+ * so we can introduce pagination later if needed.
+ */
+export interface ICommonArrayResponse<T = object> {
+    readonly data: T[];
 }
+/** Dates are serialized into strings when sent by network */
+export declare type IDateToString<T> = {
+    [Property in keyof T]: T[Property] extends Date | undefined ? string : T[Property];
+};

package/dist/types/interfaces/api/conferences.d.ts

@@ -27,3 +27,15 @@ export interface ICleanUpConferenceQuery extends ITargetAccountId {
     readonly memberId?: string;
     readonly hitlSessionId?: string;
 }
+export interface IControls {
+    readonly hold: boolean;
+    readonly mute: boolean;
+    readonly add: boolean;
+}
+export interface ICallData {
+    readonly contactId: string;
+    readonly from: string;
+    readonly onHold: boolean;
+    readonly muted: boolean;
+    readonly controls: IControls;
+}

package/dist/types/interfaces/api/helpers.d.ts

@@ -0,0 +1,21 @@
+export interface IIdentifier {
+    readonly val: string;
+    readonly type: string[];
+}
+export interface IContact {
+    readonly contactId: string;
+    readonly name?: string;
+    readonly firstName?: string;
+    readonly lastName?: string;
+    readonly companyName?: string;
+    readonly phoneNumbers?: IIdentifier[];
+    readonly emails?: IIdentifier[];
+    readonly visibilityTags?: string[];
+    readonly tags?: string[];
+}
+export interface ICleanUpDuplicatesResponse {
+    [key: string]: {
+        originalContactId: string;
+        delContactIds: string[];
+    };
+}

package/dist/types/interfaces/api/helpers.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=helpers.js.map

package/dist/types/interfaces/api/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../src/interfaces/api/helpers.ts"],"names":[],"mappings":""}

package/dist/types/interfaces/api/index.d.ts

@@ -12,3 +12,5 @@ export * as Sessions from './sessions';
 export * as SessionEvents from './session-events';
 export * as ReadEvents from './read-events';
 export * as Meta from './meta';
+export * as Commands from './commands';
+export * as Helpers from './helpers';

package/dist/types/interfaces/api/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Meta = exports.ReadEvents = exports.SessionEvents = exports.Sessions = exports.Listeners = exports.CannedMessages = exports.Filters = exports.Conferences = exports.EventTemplates = exports.RuleGroups = exports.Agents = exports.Migrations = exports.Settings = void 0;
+exports.Helpers = exports.Commands = exports.Meta = exports.ReadEvents = exports.SessionEvents = exports.Sessions = exports.Listeners = exports.CannedMessages = exports.Filters = exports.Conferences = exports.EventTemplates = exports.RuleGroups = exports.Agents = exports.Migrations = exports.Settings = void 0;
 __exportStar(require("./common"), exports);
 exports.Settings = __importStar(require("./settings"));
 exports.Migrations = __importStar(require("./migrations"));
@@ -41,4 +41,6 @@ exports.Sessions = __importStar(require("./sessions"));
 exports.SessionEvents = __importStar(require("./session-events"));
 exports.ReadEvents = __importStar(require("./read-events"));
 exports.Meta = __importStar(require("./meta"));
+exports.Commands = __importStar(require("./commands"));
+exports.Helpers = __importStar(require("./helpers"));
 //# sourceMappingURL=index.js.map

package/dist/types/interfaces/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/interfaces/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,uDAAuC;AACvC,2DAA2C;AAC3C,mDAAmC;AACnC,4DAA4C;AAC5C,oEAAoD;AACpD,6DAA6C;AAC7C,qDAAqC;AACrC,oEAAoD;AACpD,yDAAyC;AACzC,uDAAuC;AACvC,kEAAkD;AAClD,4DAA4C;AAC5C,+CAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/interfaces/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,uDAAuC;AACvC,2DAA2C;AAC3C,mDAAmC;AACnC,4DAA4C;AAC5C,oEAAoD;AACpD,6DAA6C;AAC7C,qDAAqC;AACrC,oEAAoD;AACpD,yDAAyC;AACzC,uDAAuC;AACvC,kEAAkD;AAClD,4DAA4C;AAC5C,+CAA+B;AAC/B,uDAAuC;AACvC,qDAAqC"}

package/dist/types/interfaces/api/listeners.d.ts

@@ -1,5 +1,5 @@
 import { ChannelType } from '@onereach/orbes/services/channels/channel';
-import { ITargetAccountId, ITargetUserId, ITimestamps } from './common';
+import { ITargetAccountId, ITargetUserId, ITimestamps, ICommonArrayResponse } from './common';
 export interface IListener extends ITimestamps {
     readonly callbackId: string;
     readonly callback: IListenerCallback;
@@ -22,19 +22,14 @@ export declare enum CALLBACK_TYPE {
     EVENT = "event",
     APPS = "apps"
 }
-export interface IGetListenersQuery extends ITargetAccountId, ITargetUserId {
-    readonly callbackId?: string;
-}
-export interface IGetListenersResponse {
-    readonly data: IListener[];
+export declare type ITargetCallbackId = Partial<ICallbackId>;
+export interface ICallbackId {
+    readonly callbackId: string;
 }
+export declare type IGetListenersQuery = ITargetAccountId & ITargetUserId;
+export declare type IGetListenersResponse = ICommonArrayResponse<IListener>;
 export declare type ICreateListenerQuery = ITargetAccountId & ITargetUserId;
-export declare type ICreateListenerBody = Pick<IListener, 'callback'> & Pick<Partial<IListener>, 'type' | 'version' | 'sessionIds'>;
-export declare type IUpdateListenerParams = Pick<IListener, 'callbackId'>;
-export declare type IUpdateListenerQuery = ITargetAccountId;
+export declare type ICreateListenerBody = {
+    callback: Partial<IListenerCallback>;
+} & Pick<Partial<IListener>, 'type' | 'version' | 'sessionIds'>;
 export declare type IUpdateListenerBody = Pick<IListener, 'sessionIds'>;
-export declare type IUpdateListenerOptions = IUpdateListenerParams & IUpdateListenerBody;
-export declare type IDeleteListenerQuery = ITargetAccountId;
-export interface IDeleteListenerParams {
-    readonly callbackId: string;
-}

package/dist/types/interfaces/api/listeners.js.map

@@ -1 +1 @@
-{"version":3,"file":"listeners.js","sourceRoot":"","sources":["../../../../src/interfaces/api/listeners.ts"],"names":[],"mappings":";;;AAsBA,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,8BAAa,CAAA;AACf,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB"}
+{"version":3,"file":"listeners.js","sourceRoot":"","sources":["../../../../src/interfaces/api/listeners.ts"],"names":[],"mappings":";;;AA2BA,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,8BAAa,CAAA;AACf,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB"}

package/dist/types/interfaces/api/read-events.d.ts

@@ -5,11 +5,11 @@ export interface IReadEvent {
     readonly eventTimestamp: Date;
     readonly sessionId: string;
 }
-export declare type IGetNewEventsAmountQuery = ITargetAccountId & ITargetUserId;
-export interface IGetNewEventsAmountBody {
+export declare type IGetNewEventsCountQuery = ITargetAccountId & ITargetUserId;
+export interface IGetNewEventsCountBody {
     readonly sessionIds: string[];
 }
-export interface IGetNewEventsAmountResponse {
+export interface IGetNewEventsCountResponse {
     readonly data: {
         readonly [sessionId: string]: {
             nEvents: number;
@@ -20,5 +20,5 @@ export declare type ISaveLastReadEventQuery = ITargetAccountId & ITargetUserId;
 export interface ISaveLastReadEventBody {
     readonly sessionId: string;
     readonly eventId: string;
-    readonly eventTimestamp: string;
+    readonly eventTimestamp: string | number;
 }

package/dist/types/interfaces/api/session-events.d.ts

@@ -1,4 +1,4 @@
-import { ITargetAccountId, JSONType } from './common';
+import { ITargetAccountId, ISessionId, ICommonArrayResponse, JSONType } from './common';
 export interface ISessionEvent {
     readonly eventId: string;
     readonly accountId?: string;
@@ -16,9 +16,10 @@ export interface ISessionEvent {
     readonly transactionId?: string;
     readonly version?: number;
 }
-export interface IGetSessionEventsQuery extends ITargetAccountId {
-    readonly sessionId: string;
-}
-export interface IGetSessionEventsResponse {
-    readonly data: ISessionEvent[];
+export declare type IGetSessionEventsQuery = ITargetAccountId & ISessionId;
+export declare type IGetSessionEventsResponse = ICommonArrayResponse<ISessionEvent>;
+export declare type IAddEventsBySessionIdQuery = ITargetAccountId & ISessionId;
+export interface IAddEventsBySessionIdBody {
+    readonly events: Partial<ISessionEvent>[];
 }
+export declare type IAddEventsBySessionIdResponse = ICommonArrayResponse<ISessionEvent>;

package/dist/types/interfaces/api/sessions.d.ts

@@ -1,5 +1,5 @@
 import { ITriggersResponse } from '@onereach/sdk';
-import { JSONType, ITimestamps, ITargetAccountId, ITargetUserId, IPageOptions } from './common';
+import { ITimestamps, ITargetAccountId, ITargetUserId, IPageOptions, JSONType } from './common';
 import { SESSION_STATUS } from '@/constants/api';
 export interface ISession extends ITimestamps {
     readonly hitlSessionId: string;
@@ -31,12 +31,13 @@ export interface ICommand {
     readonly name: string;
     readonly ruleTags: string[];
     readonly allowUnclaimed: boolean;
+    readonly visibility?: 'default' | 'api';
 }
-interface ICommandParam {
+export interface ICommandParam {
     readonly properties: ICommandParamProperties;
     readonly name: string;
 }
-interface ICommandParamProperties {
+export interface ICommandParamProperties {
     readonly source: string;
     readonly type: string;
     readonly options: string[];
@@ -44,7 +45,7 @@ interface ICommandParamProperties {
 }
 export interface IGetSessionByIdOptions {
     readonly accountId: string;
-    readonly hitlSessionId: string;
+    readonly sessionId: string;
     readonly agentId: string;
     readonly projection?: string[];
 }
@@ -59,12 +60,12 @@ export interface IGetSessionsOptions {
     readonly orderBy?: string;
     readonly page?: IPageOptions;
 }
-export declare type IGetSessionsQuery = IGetSessionByIdOptions & IGetSessionsOptions & ITargetAccountId & ITargetUserId;
+export declare type IGetSessionsQuery = Partial<IGetSessionsOptions>;
+export declare type IGetSessionByIdQuery = Partial<Omit<IGetSessionByIdOptions, 'sessionId'>>;
 export interface IGetSessionsResponse {
     readonly data: ISession[];
     readonly page?: {
         readonly value?: string;
-        readonly uniqueId?: string;
         readonly nextId?: string;
     };
 }
@@ -101,17 +102,17 @@ export interface ISearchSessionsOptions {
     readonly meta?: Record<string, string>;
     readonly sessionsSearchOptions?: ISessionSearchOptions;
 }
-export declare type ISearchSessionsQuery = ISearchSessionsOptions & ITargetAccountId & ITargetUserId;
+export declare type ISearchSessionsQuery = ITargetAccountId & ITargetUserId;
+export declare type ISearchSessionsBody = Omit<ISearchSessionsOptions, 'accountId' | 'agentId'>;
 export interface ISearchSessionsWithContactsResponse {
     readonly data: ISession[];
     readonly page?: {
         readonly value?: string;
-        readonly uniqueId?: string;
         readonly nextId?: string;
     };
     readonly contacts: {
-        data: object[];
-        total: number;
+        readonly data: object[];
+        readonly total: number;
     };
 }
 export interface IContactSearchParams {
@@ -130,19 +131,18 @@ export interface ISearchSessionsWithContactsOptions {
     readonly sessionsSearchOptions?: ISessionSearchOptions;
     readonly contactsSearchOptions?: IContactSearchOptions;
 }
-export declare type ISearchSessionsWithContactsQuery = ISearchSessionsWithContactsOptions & ITargetAccountId & ITargetUserId;
+export declare type ISearchSessionsWithContactsQuery = ITargetAccountId & ITargetUserId;
+export declare type ISearchSessionsWithContactsBody = Omit<ISearchSessionsWithContactsOptions, 'accountId' | 'agentId'>;
 export interface IGetQueueSessionOptions {
     readonly accountId: string;
     readonly agentId: string;
     readonly ruleTags?: string[];
 }
+export declare type IGetQueueSessionQuery = Partial<IGetQueueSessionOptions> & ITargetAccountId;
 export interface IGetQueueSessionResponse {
     readonly data: ISession | null;
 }
-export declare type IGetQueueSessionQuery = IGetQueueSessionOptions & ITargetAccountId;
-export interface ISessionActionParams {
-    readonly sessionId?: string;
-}
+export declare type IGetInitTriggersResponse = ITriggersResponse[];
 export interface IClaimSessionQuery extends ITargetAccountId {
     readonly claimBy?: string[];
 }
@@ -153,5 +153,13 @@ export declare type ITransferToBotQuery = ITargetAccountId & ITargetUserId;
 export interface ITransferToBotBody {
     readonly params?: object;
 }
-export declare type IGetInitTriggersResponse = ITriggersResponse[];
-export {};
+export interface IUpdateSessionBody {
+    readonly tags?: string[];
+}
+export interface IInitConversationQuery extends ITargetAccountId {
+    readonly triggerId: string;
+    readonly contactId: string;
+}
+export interface IInitConversationBody {
+    readonly params?: object;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/types-hitl-api",
-  "version": "0.0.32-rc.1",
+  "version": "0.0.32-rc.10",
   "author": "OneReach.ai",
   "main": "dist/types/index.types.js",
   "types": "dist/types/index.types.d.ts",