@onereach/types-hitl-api 0.0.32-rc.8 → 0.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -44,4 +44,14 @@ export declare const BROADCAST_EVENTS: {
44
44
  UPSERT_SESSION: string;
45
45
  NOTIFY_AGENTS: string;
46
46
  MULTI_ACTION: string;
47
+ START_CALL: string;
48
+ UPSERT_CONFERENCE_MEMBER: string;
49
+ };
50
+ export declare const CONTACT_BROADCAST_EVENTS: {
51
+ DELETE: string;
52
+ UPSERT: string;
53
+ MERGE: string;
54
+ };
55
+ export declare const AGENT_BROADCAST_EVENTS: {
56
+ SET_AGENT_STATUS: string;
47
57
  };
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BROADCAST_EVENTS = exports.APP_ERROR_TYPE = exports.CALL_MEMBER_TYPE = exports.CALL_MEMBER_STATUS = exports.SESSION_STATUS = exports.AGENT_STATUS = void 0;
3
+ 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;
4
4
  var AGENT_STATUS;
5
5
  (function (AGENT_STATUS) {
6
6
  AGENT_STATUS["AVAILABLE"] = "AVAILABLE";
@@ -52,5 +52,15 @@ exports.BROADCAST_EVENTS = {
52
52
  UPSERT_SESSION: 'UPSERT_SESSION',
53
53
  NOTIFY_AGENTS: 'NOTIFY_AGENTS',
54
54
  MULTI_ACTION: 'MULTI_ACTION',
55
+ START_CALL: 'START_CALL',
56
+ UPSERT_CONFERENCE_MEMBER: 'UPSERT_CONFERENCE_MEMBER',
57
+ };
58
+ exports.CONTACT_BROADCAST_EVENTS = {
59
+ DELETE: 'DELETE_CONTACT',
60
+ UPSERT: 'UPSERT_CONTACT',
61
+ MERGE: 'MERGE_CONTACTS',
62
+ };
63
+ exports.AGENT_BROADCAST_EVENTS = {
64
+ SET_AGENT_STATUS: 'SET_AGENT_STATUS',
55
65
  };
56
66
  //# sourceMappingURL=api.js.map
@@ -1 +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;CAC7B,CAAC"}
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"}
@@ -1,4 +1,5 @@
1
1
  import { AGENT_STATUS } from '@/constants/api';
2
+ import { ITargetAccountId } from '@/interfaces/api/common';
2
3
  export interface IAgentStatus {
3
4
  readonly agentId?: string;
4
5
  readonly status: AGENT_STATUS;
@@ -13,3 +14,13 @@ export interface IAgentStatusSettings {
13
14
  readonly defaultLoginStatusReason?: string;
14
15
  readonly busyStatusReasons?: string[];
15
16
  }
17
+ export interface ISetAgentStatusOptions {
18
+ readonly accountId: string;
19
+ readonly agentId: string;
20
+ readonly statusData: Pick<IAgentStatus, 'status' | 'busyReason'>;
21
+ readonly notifyStatusChange: boolean;
22
+ }
23
+ export interface ISetAgentStatusQuery extends ITargetAccountId {
24
+ agentId: string;
25
+ }
26
+ export declare type ISetAgentStatusBody = Omit<ISetAgentStatusOptions, 'accountId' | 'agentId'>;
@@ -34,3 +34,7 @@ export interface IPageOptions {
34
34
  export interface ICommonArrayResponse<T = object> {
35
35
  readonly data: T[];
36
36
  }
37
+ /** Dates are serialized into strings when sent by network */
38
+ export declare type IDateToString<T> = {
39
+ [Property in keyof T]: T[Property] extends Date | undefined ? string : T[Property];
40
+ };
@@ -27,3 +27,15 @@ export interface ICleanUpConferenceQuery extends ITargetAccountId {
27
27
  readonly memberId?: string;
28
28
  readonly hitlSessionId?: string;
29
29
  }
30
+ export interface IControls {
31
+ readonly hold: boolean;
32
+ readonly mute: boolean;
33
+ readonly add: boolean;
34
+ }
35
+ export interface ICallData {
36
+ readonly contactId: string;
37
+ readonly from: string;
38
+ readonly onHold: boolean;
39
+ readonly muted: boolean;
40
+ readonly controls: IControls;
41
+ }
@@ -0,0 +1,12 @@
1
+ import { ITargetAccountId, ITimestamps, IDateToString } from './common';
2
+ export interface IContactMeta extends ITimestamps {
3
+ readonly contactId: string;
4
+ readonly eventTimestamp: Date;
5
+ }
6
+ export declare type ISearchContactsMetaQuery = ITargetAccountId;
7
+ export interface ISearchContactsMetaBody {
8
+ readonly contactIds: string[];
9
+ }
10
+ export interface ISearchContactsMetaResponse {
11
+ readonly data: Record<string, IDateToString<IContactMeta>>;
12
+ }
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=meta.js.map
3
+ //# sourceMappingURL=contacts-meta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"contacts-meta.js","sourceRoot":"","sources":["../../../../src/interfaces/api/contacts-meta.ts"],"names":[],"mappings":""}
@@ -11,6 +11,6 @@ export * as Listeners from './listeners';
11
11
  export * as Sessions from './sessions';
12
12
  export * as SessionEvents from './session-events';
13
13
  export * as ReadEvents from './read-events';
14
- export * as Meta from './meta';
15
14
  export * as Commands from './commands';
16
15
  export * as Helpers from './helpers';
16
+ export * as ContactsMeta from './contacts-meta';
@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
26
26
  return result;
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- 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;
29
+ 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;
30
30
  __exportStar(require("./common"), exports);
31
31
  exports.Settings = __importStar(require("./settings"));
32
32
  exports.Migrations = __importStar(require("./migrations"));
@@ -40,7 +40,7 @@ exports.Listeners = __importStar(require("./listeners"));
40
40
  exports.Sessions = __importStar(require("./sessions"));
41
41
  exports.SessionEvents = __importStar(require("./session-events"));
42
42
  exports.ReadEvents = __importStar(require("./read-events"));
43
- exports.Meta = __importStar(require("./meta"));
44
43
  exports.Commands = __importStar(require("./commands"));
45
44
  exports.Helpers = __importStar(require("./helpers"));
45
+ exports.ContactsMeta = __importStar(require("./contacts-meta"));
46
46
  //# sourceMappingURL=index.js.map
@@ -1 +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;AAC/B,uDAAuC;AACvC,qDAAqC"}
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"}
@@ -29,5 +29,7 @@ export interface ICallbackId {
29
29
  export declare type IGetListenersQuery = ITargetAccountId & ITargetUserId;
30
30
  export declare type IGetListenersResponse = ICommonArrayResponse<IListener>;
31
31
  export declare type ICreateListenerQuery = ITargetAccountId & ITargetUserId;
32
- export declare type ICreateListenerBody = Pick<IListener, 'callback'> & Pick<Partial<IListener>, 'type' | 'version' | 'sessionIds'>;
32
+ export declare type ICreateListenerBody = {
33
+ callback: Partial<IListenerCallback>;
34
+ } & Pick<Partial<IListener>, 'type' | 'version' | 'sessionIds'>;
33
35
  export declare type IUpdateListenerBody = Pick<IListener, 'sessionIds'>;
@@ -17,3 +17,7 @@ export interface IGetMigrationsResponse {
17
17
  readonly executed: IMigration[];
18
18
  readonly pending: IMigration[];
19
19
  }
20
+ export declare type ICreateDefaultRecordsQuery = ITargetAccountId;
21
+ export interface ICreateDefaultRecordsResponse {
22
+ readonly tables: string[];
23
+ }
@@ -31,6 +31,7 @@ export interface ICommand {
31
31
  readonly name: string;
32
32
  readonly ruleTags: string[];
33
33
  readonly allowUnclaimed: boolean;
34
+ readonly visibility?: 'default' | 'api';
34
35
  }
35
36
  export interface ICommandParam {
36
37
  readonly properties: ICommandParamProperties;
@@ -59,8 +60,8 @@ export interface IGetSessionsOptions {
59
60
  readonly orderBy?: string;
60
61
  readonly page?: IPageOptions;
61
62
  }
62
- export declare type IGetSessionsQuery = Partial<IGetSessionsOptions> & ITargetAccountId & ITargetUserId;
63
- export declare type IGetSessionByIdQuery = Partial<IGetSessionByIdOptions> & ITargetAccountId & ITargetUserId;
63
+ export declare type IGetSessionsQuery = Partial<IGetSessionsOptions>;
64
+ export declare type IGetSessionByIdQuery = Partial<Omit<IGetSessionByIdOptions, 'sessionId'>>;
64
65
  export interface IGetSessionsResponse {
65
66
  readonly data: ISession[];
66
67
  readonly page?: {
@@ -101,7 +102,8 @@ export interface ISearchSessionsOptions {
101
102
  readonly meta?: Record<string, string>;
102
103
  readonly sessionsSearchOptions?: ISessionSearchOptions;
103
104
  }
104
- export declare type ISearchSessionsQuery = Partial<ISearchSessionsOptions> & ITargetAccountId & ITargetUserId;
105
+ export declare type ISearchSessionsQuery = ITargetAccountId & ITargetUserId;
106
+ export declare type ISearchSessionsBody = Omit<ISearchSessionsOptions, 'accountId' | 'agentId'>;
105
107
  export interface ISearchSessionsWithContactsResponse {
106
108
  readonly data: ISession[];
107
109
  readonly page?: {
@@ -129,7 +131,8 @@ export interface ISearchSessionsWithContactsOptions {
129
131
  readonly sessionsSearchOptions?: ISessionSearchOptions;
130
132
  readonly contactsSearchOptions?: IContactSearchOptions;
131
133
  }
132
- export declare type ISearchSessionsWithContactsQuery = Partial<ISearchSessionsWithContactsOptions> & ITargetAccountId & ITargetUserId;
134
+ export declare type ISearchSessionsWithContactsQuery = ITargetAccountId & ITargetUserId;
135
+ export declare type ISearchSessionsWithContactsBody = Omit<ISearchSessionsWithContactsOptions, 'accountId' | 'agentId'>;
133
136
  export interface IGetQueueSessionOptions {
134
137
  readonly accountId: string;
135
138
  readonly agentId: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onereach/types-hitl-api",
3
- "version": "0.0.32-rc.8",
3
+ "version": "0.0.32",
4
4
  "author": "OneReach.ai",
5
5
  "main": "dist/types/index.types.js",
6
6
  "types": "dist/types/index.types.d.ts",
@@ -1,5 +0,0 @@
1
- import { ITimestamps } from './common';
2
- export interface IContactMeta extends ITimestamps {
3
- readonly contactId: string;
4
- readonly sessionTimestamp: Date;
5
- }
@@ -1 +0,0 @@
1
- {"version":3,"file":"meta.js","sourceRoot":"","sources":["../../../../src/interfaces/api/meta.ts"],"names":[],"mappings":""}