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

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

@@ -3,6 +3,12 @@ export declare enum AGENT_STATUS {
     BUSY = "BUSY",
     OFFLINE = "OFFLINE"
 }
+export declare enum USER_ROLE {
+    GUEST = "GUEST",
+    USER = "USER",
+    ADMIN = "ADMIN",
+    SUPER_ADMIN = "SUPER_ADMIN"
+}
 export declare enum SESSION_STATUS {
     CLAIMED = "CLAIMED",
     ONGOING = "ONGOING",
@@ -59,4 +65,5 @@ export declare const COMMANDS: {
     CONTINUE: string;
     NOT_CLAIMED: string;
     CLAIM_TIMER: string;
+    CHANGE_CONTACT: string;
 };

package/dist/types/constants/api.js

@@ -1,12 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.COMMANDS = exports.AGENT_BROADCAST_EVENTS = exports.CONTACT_BROADCAST_EVENTS = exports.BROADCAST_EVENTS = exports.APP_ERROR_TYPE = exports.CALL_MEMBER_TYPE = exports.CALL_MEMBER_STATUS = exports.SESSION_STATUS = exports.AGENT_STATUS = void 0;
+exports.COMMANDS = exports.AGENT_BROADCAST_EVENTS = exports.CONTACT_BROADCAST_EVENTS = exports.BROADCAST_EVENTS = exports.APP_ERROR_TYPE = exports.CALL_MEMBER_TYPE = exports.CALL_MEMBER_STATUS = exports.SESSION_STATUS = exports.USER_ROLE = exports.AGENT_STATUS = void 0;
 var AGENT_STATUS;
 (function (AGENT_STATUS) {
     AGENT_STATUS["AVAILABLE"] = "AVAILABLE";
     AGENT_STATUS["BUSY"] = "BUSY";
     AGENT_STATUS["OFFLINE"] = "OFFLINE";
 })(AGENT_STATUS = exports.AGENT_STATUS || (exports.AGENT_STATUS = {}));
+var USER_ROLE;
+(function (USER_ROLE) {
+    USER_ROLE["GUEST"] = "GUEST";
+    USER_ROLE["USER"] = "USER";
+    USER_ROLE["ADMIN"] = "ADMIN";
+    USER_ROLE["SUPER_ADMIN"] = "SUPER_ADMIN";
+})(USER_ROLE = exports.USER_ROLE || (exports.USER_ROLE = {}));
 var SESSION_STATUS;
 (function (SESSION_STATUS) {
     SESSION_STATUS["CLAIMED"] = "CLAIMED";
@@ -67,5 +74,6 @@ exports.COMMANDS = {
     CONTINUE: 'continue',
     NOT_CLAIMED: 'notclaimed',
     CLAIM_TIMER: 'claim-timer',
+    CHANGE_CONTACT: 'change-contact',
 };
 //# 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,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;AAEW,QAAA,wBAAwB,GAAG;IACtC,MAAM,EAAE,gBAAgB;IACxB,MAAM,EAAE,gBAAgB;IACxB,KAAK,EAAE,gBAAgB;CACxB,CAAC;AAEW,QAAA,sBAAsB,GAAG;IACpC,gBAAgB,EAAE,kBAAkB;CACrC,CAAC;AAEW,QAAA,QAAQ,GAAG;IACtB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,YAAY;IACzB,WAAW,EAAE,aAAa;CAC3B,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,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,wCAA2B,CAAA;AAC7B,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;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;AAEW,QAAA,wBAAwB,GAAG;IACtC,MAAM,EAAE,gBAAgB;IACxB,MAAM,EAAE,gBAAgB;IACxB,KAAK,EAAE,gBAAgB;CACxB,CAAC;AAEW,QAAA,sBAAsB,GAAG;IACpC,gBAAgB,EAAE,kBAAkB;CACrC,CAAC;AAEW,QAAA,QAAQ,GAAG;IACtB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,YAAY;IACzB,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAE,gBAAgB;CACjC,CAAC"}

package/dist/types/interfaces/api/agents-meta.d.ts

@@ -0,0 +1,9 @@
+import { IAgentStatus } from '@/interfaces/api/agents';
+import { ITimestamps } from '@/interfaces/api/common';
+export interface IAgentMeta extends ITimestamps {
+    readonly id: string;
+    readonly agentId: string;
+    readonly ruleGroupIds: string[];
+    readonly statusData: Omit<IAgentStatus, 'agentId'>;
+    readonly meta: object;
+}

package/dist/types/interfaces/api/agents-meta.js

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

package/dist/types/interfaces/api/agents-meta.js.map

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

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

@@ -1,15 +1,20 @@
-import { AGENT_STATUS } from '@/constants/api';
+import { AGENT_STATUS, USER_ROLE } from '@/constants/api';
 import { ITargetAccountId } from '@/interfaces/api/common';
-export interface IAgent {
+export interface IAgent<T extends IMeta = IMeta> {
     readonly accountId: string;
     readonly id: string;
     readonly multiUserId: string;
-    readonly role: string;
+    readonly role: USER_ROLE;
     readonly email: string;
     readonly username: string;
+    readonly data: object;
     readonly ruleGroupIds: string[];
-    readonly statusData?: Omit<IAgentStatus, 'agentId'>;
-    readonly meta?: object;
+    readonly statusData: Omit<IAgentStatus, 'agentId'>;
+    readonly meta: T;
+}
+export interface IMeta {
+    readonly name?: string;
+    readonly email: string;
 }
 export interface IGetAgentsQuery extends ITargetAccountId {
     readonly agentIds?: string[];
@@ -37,6 +42,16 @@ export interface IGetAgentsResponse {
         readonly accountId?: string;
     };
 }
+export interface ISearchAgentsQuery extends ITargetAccountId {
+    readonly ruleGroupIds?: string[];
+    readonly ruleTags?: string[];
+    readonly excludeAgentIds?: string[];
+    readonly status?: string;
+    readonly projection?: string[];
+}
+export interface ISearchAgentsResponse {
+    readonly data: Partial<IAgent>[];
+}
 export interface IAgentStatus {
     readonly agentId?: string;
     readonly status: AGENT_STATUS;
@@ -66,8 +81,8 @@ export interface IPutAgentMetaBody {
 export interface IPutAgentRuleGroupsOptions {
     readonly accountId: string;
     readonly agentId: string;
-    readonly addRuleGroupIds: string[];
-    readonly removeRuleGroupIds: string[];
+    readonly addRuleGroupIds?: string[];
+    readonly removeRuleGroupIds?: string[];
 }
 export declare type IPutAgentRuleGroupsQuery = ISetAgentStatusQuery;
 export declare type IPutAgentRuleGroupsBody = Omit<IPutAgentRuleGroupsOptions, 'accountId' | 'agentId'>;
@@ -76,8 +91,14 @@ export interface ISetAgentStatusOptions {
     readonly agentId: string;
     readonly statusData: Pick<IAgentStatus, 'status' | 'busyReason'>;
     readonly notifyStatusChange: boolean;
+    readonly ctx?: object;
 }
 export interface ISetAgentStatusQuery extends ITargetAccountId {
     agentId: string;
 }
 export declare type ISetAgentStatusBody = Omit<ISetAgentStatusOptions, 'accountId' | 'agentId'>;
+export declare type IUpdateAgentsStatusQuery = ITargetAccountId;
+export interface IUpdateAgentsStatusBody {
+    readonly query: string;
+    readonly ctx?: object;
+}

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

@@ -14,3 +14,4 @@ export * as ReadEvents from './read-events';
 export * as Commands from './commands';
 export * as Helpers from './helpers';
 export * as ContactsMeta from './contacts-meta';
+export * as AgentsMeta from './agents-meta';

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.ContactsMeta = exports.Helpers = exports.Commands = 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.AgentsMeta = exports.ContactsMeta = exports.Helpers = exports.Commands = 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"));
@@ -43,4 +43,5 @@ exports.ReadEvents = __importStar(require("./read-events"));
 exports.Commands = __importStar(require("./commands"));
 exports.Helpers = __importStar(require("./helpers"));
 exports.ContactsMeta = __importStar(require("./contacts-meta"));
+exports.AgentsMeta = __importStar(require("./agents-meta"));
 //# 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,uDAAuC;AACvC,qDAAqC;AACrC,gEAAgD"}
+{"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,uDAAuC;AACvC,qDAAqC;AACrC,gEAAgD;AAChD,4DAA4C"}

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

@@ -155,6 +155,7 @@ export interface ITransferToBotBody {
 }
 export interface IUpdateSessionBody {
     readonly tags?: string[];
+    readonly contactId?: string;
 }
 export interface IInitConversationQuery extends ITargetAccountId {
     readonly triggerId: string;

package/package.json

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