@or-sdk/hitl 0.37.2 → 0.38.0
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.
- package/CHANGELOG.md +9 -0
- package/dist/cjs/HITL.js +1 -1
- package/dist/cjs/HITL.js.map +1 -1
- package/dist/cjs/api/{ScheduledMessages.js → DraftMessages.js} +12 -12
- package/dist/cjs/api/DraftMessages.js.map +1 -0
- package/dist/cjs/api/index.js +3 -3
- package/dist/cjs/api/index.js.map +1 -1
- package/dist/cjs/types/{scheduled-messages.js → draft-messages.js} +1 -1
- package/dist/cjs/types/draft-messages.js.map +1 -0
- package/dist/cjs/types/index.js +2 -2
- package/dist/cjs/types/index.js.map +1 -1
- package/dist/esm/HITL.js +2 -2
- package/dist/esm/HITL.js.map +1 -1
- package/dist/esm/api/{ScheduledMessages.js → DraftMessages.js} +7 -7
- package/dist/esm/api/DraftMessages.js.map +1 -0
- package/dist/esm/api/index.js +1 -1
- package/dist/esm/api/index.js.map +1 -1
- package/dist/esm/types/draft-messages.js +2 -0
- package/dist/esm/types/draft-messages.js.map +1 -0
- package/dist/esm/types/index.js +2 -2
- package/dist/esm/types/index.js.map +1 -1
- package/dist/types/HITL.d.ts +15 -2
- package/dist/types/HITL.d.ts.map +1 -1
- package/dist/types/api/Agents.d.ts +347 -0
- package/dist/types/api/Agents.d.ts.map +1 -1
- package/dist/types/api/CannedMessages.d.ts +168 -0
- package/dist/types/api/CannedMessages.d.ts.map +1 -1
- package/dist/types/api/Commands.d.ts +48 -0
- package/dist/types/api/Commands.d.ts.map +1 -1
- package/dist/types/api/Conferences.d.ts +120 -0
- package/dist/types/api/Conferences.d.ts.map +1 -1
- package/dist/types/api/ContactRuleGroups.d.ts +131 -0
- package/dist/types/api/ContactRuleGroups.d.ts.map +1 -1
- package/dist/types/api/Contacts.d.ts +37 -0
- package/dist/types/api/Contacts.d.ts.map +1 -1
- package/dist/types/api/ContactsMeta.d.ts +33 -0
- package/dist/types/api/ContactsMeta.d.ts.map +1 -1
- package/dist/types/api/DraftMessages.d.ts +177 -0
- package/dist/types/api/DraftMessages.d.ts.map +1 -0
- package/dist/types/api/EventTemplates.d.ts +135 -0
- package/dist/types/api/EventTemplates.d.ts.map +1 -1
- package/dist/types/api/Filters.d.ts +215 -0
- package/dist/types/api/Filters.d.ts.map +1 -1
- package/dist/types/api/HITLBase.d.ts +5 -0
- package/dist/types/api/HITLBase.d.ts.map +1 -1
- package/dist/types/api/Helpers.d.ts +33 -0
- package/dist/types/api/Helpers.d.ts.map +1 -1
- package/dist/types/api/Listeners.d.ts +150 -0
- package/dist/types/api/Listeners.d.ts.map +1 -1
- package/dist/types/api/Migrations.d.ts +222 -0
- package/dist/types/api/Migrations.d.ts.map +1 -1
- package/dist/types/api/RuleGroups.d.ts +127 -0
- package/dist/types/api/RuleGroups.d.ts.map +1 -1
- package/dist/types/api/SessionEvents.d.ts +145 -0
- package/dist/types/api/SessionEvents.d.ts.map +1 -1
- package/dist/types/api/SessionRelations.d.ts +109 -0
- package/dist/types/api/SessionRelations.d.ts.map +1 -1
- package/dist/types/api/Sessions.d.ts +456 -0
- package/dist/types/api/Sessions.d.ts.map +1 -1
- package/dist/types/api/Settings.d.ts +145 -0
- package/dist/types/api/Settings.d.ts.map +1 -1
- package/dist/types/api/Tasks.d.ts +39 -0
- package/dist/types/api/Tasks.d.ts.map +1 -1
- package/dist/types/api/Versions.d.ts +80 -0
- package/dist/types/api/Versions.d.ts.map +1 -1
- package/dist/types/api/index.d.ts +1 -1
- package/dist/types/api/index.d.ts.map +1 -1
- package/dist/types/types/agents.d.ts +3 -0
- package/dist/types/types/agents.d.ts.map +1 -1
- package/dist/types/types/draft-messages.d.ts +16 -0
- package/dist/types/types/draft-messages.d.ts.map +1 -0
- package/dist/types/types/index.d.ts +1 -1
- package/dist/types/types/index.d.ts.map +1 -1
- package/package.json +3 -3
- package/src/HITL.ts +3 -3
- package/src/api/{ScheduledMessages.ts → DraftMessages.ts} +52 -52
- package/src/api/index.ts +1 -1
- package/src/types/draft-messages.ts +23 -0
- package/src/types/index.ts +1 -1
- package/dist/cjs/api/ScheduledMessages.js.map +0 -1
- package/dist/cjs/types/scheduled-messages.js.map +0 -1
- package/dist/esm/api/ScheduledMessages.js.map +0 -1
- package/dist/esm/types/scheduled-messages.js +0 -2
- package/dist/esm/types/scheduled-messages.js.map +0 -1
- package/dist/types/api/ScheduledMessages.d.ts +0 -10
- package/dist/types/api/ScheduledMessages.d.ts.map +0 -1
- package/dist/types/types/scheduled-messages.d.ts +0 -16
- package/dist/types/types/scheduled-messages.d.ts.map +0 -1
- package/src/types/scheduled-messages.ts +0 -23
|
@@ -1,7 +1,46 @@
|
|
|
1
1
|
import { RunTaskOptions } from '../types/tasks';
|
|
2
2
|
import { HITLBase } from './HITLBase';
|
|
3
|
+
/**
|
|
4
|
+
* Manages asynchronous task execution in the system
|
|
5
|
+
*
|
|
6
|
+
* This class provides functionality to:
|
|
7
|
+
* - Execute various system tasks like event sending, broadcasting, sharing cards to agents, etc.
|
|
8
|
+
*
|
|
9
|
+
* @remarks
|
|
10
|
+
* - All methods in this class interact with the `/tasks` endpoint
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
3
13
|
export declare class Tasks extends HITLBase {
|
|
4
14
|
protected static MODULE_URL: string;
|
|
15
|
+
/**
|
|
16
|
+
* Executes a specified task with provided data
|
|
17
|
+
*
|
|
18
|
+
* @param options - Configuration parameters for task execution
|
|
19
|
+
*
|
|
20
|
+
* Required parameters:
|
|
21
|
+
* - `task` - (string) The type/name of task to execute
|
|
22
|
+
* - `data` - (object) Task-specific data required for execution
|
|
23
|
+
*
|
|
24
|
+
* Optional parameters:
|
|
25
|
+
* - `timeout` - (number) Request timeout in milliseconds
|
|
26
|
+
* - `version` - (string | number) API version to use
|
|
27
|
+
*
|
|
28
|
+
* @returns {Promise<void>} Promise that resolves when the task is initiated
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```typescript
|
|
32
|
+
* await hitlApi.tasks.runTask({
|
|
33
|
+
* task: 'shareCardsToAgents',
|
|
34
|
+
* data: {
|
|
35
|
+
* cardIds: ['card-id-1', 'card-id-2'],
|
|
36
|
+
* }
|
|
37
|
+
* });
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @remarks
|
|
41
|
+
* Makes a POST request to the `/tasks` endpoint
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
5
44
|
static runTask({ task, data, ...options }: RunTaskOptions): Promise<void>;
|
|
6
45
|
}
|
|
7
46
|
//# sourceMappingURL=Tasks.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Tasks.d.ts","sourceRoot":"","sources":["../../../src/api/Tasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"Tasks.d.ts","sourceRoot":"","sources":["../../../src/api/Tasks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;GASG;AACH,qBAAa,KAAM,SAAQ,QAAQ;IACjC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAW;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACiB,OAAO,CACzB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,cAAc,GACzC,OAAO,CAAC,IAAI,CAAC;CAWjB"}
|
|
@@ -1,12 +1,92 @@
|
|
|
1
1
|
import { ApiVersionOptions } from '../types';
|
|
2
2
|
import { GetVersionsListResponse, GetVersionInfoResponse, GetStepsToUIVersionsMapOptions } from '../types/versions';
|
|
3
3
|
import { HITLBase } from './HITLBase';
|
|
4
|
+
/**
|
|
5
|
+
* Manages UI version information and compatibility
|
|
6
|
+
*
|
|
7
|
+
* This class provides functionality to:
|
|
8
|
+
* - Retrieve available UI versions
|
|
9
|
+
* - Get detailed version information
|
|
10
|
+
*
|
|
11
|
+
* Key features:
|
|
12
|
+
* - List all available UI versions
|
|
13
|
+
* - Get specific version details
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* - All methods in this class interact with the `/ui-versions` endpoint
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
4
19
|
export declare class Versions extends HITLBase {
|
|
5
20
|
protected static MODULE_URL: string;
|
|
6
21
|
protected static VERSION_INFO: string;
|
|
7
22
|
protected static STEPS_TO_UI_VERSIONS_MAP: string;
|
|
23
|
+
/**
|
|
24
|
+
* Retrieves a list of available UI versions
|
|
25
|
+
*
|
|
26
|
+
* @param options - Configuration parameters for retrieving versions
|
|
27
|
+
*
|
|
28
|
+
* Optional parameters:
|
|
29
|
+
* - `timeout` - (number) Request timeout in milliseconds
|
|
30
|
+
* - `version` - (string | number) API version to use
|
|
31
|
+
*
|
|
32
|
+
* @returns {Promise<GetVersionsListResponse>} Promise resolving to the list of available versions
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```typescript
|
|
36
|
+
* const versions = await hitlApi.versions.getVersionsList();
|
|
37
|
+
* ```
|
|
38
|
+
*
|
|
39
|
+
* @remarks
|
|
40
|
+
* Makes a GET request to the `/ui-versions` endpoint
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
8
43
|
static getVersionsList(options: ApiVersionOptions): Promise<GetVersionsListResponse>;
|
|
44
|
+
/**
|
|
45
|
+
* Retrieves detailed information about the last available version of HitL UI
|
|
46
|
+
*
|
|
47
|
+
* @param options - Configuration parameters for retrieving version information
|
|
48
|
+
*
|
|
49
|
+
* Optional parameters:
|
|
50
|
+
* - `timeout` - (number) Request timeout in milliseconds
|
|
51
|
+
* - `version` - (string | number) API version to use
|
|
52
|
+
*
|
|
53
|
+
* @returns {Promise<GetVersionInfoResponse>} Promise resolving to the version information
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```typescript
|
|
57
|
+
* const versionInfo = await hitlApi.versions.getVersionInfo();
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* Makes a GET request to the `/ui-versions/version-info` endpoint
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
9
64
|
static getVersionInfo(options: ApiVersionOptions): Promise<GetVersionInfoResponse>;
|
|
65
|
+
/**
|
|
66
|
+
* Retrieves information about the compatibility of steps to UI versions
|
|
67
|
+
*
|
|
68
|
+
* @param options - Configuration parameters for retrieving steps to UI versions map
|
|
69
|
+
*
|
|
70
|
+
* Optional parameters:
|
|
71
|
+
* - `stepName` - (string) The name of the step to retrieve mapping information for
|
|
72
|
+
* - `timeout` - (number) Request timeout in milliseconds
|
|
73
|
+
* - `version` - (string | number) API version to use
|
|
74
|
+
*
|
|
75
|
+
* @returns {Promise<GetStepsToUIVersionsMapResponse>} Promise resolving to steps to UI versions map
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```typescript
|
|
79
|
+
* const stepsToUIVesionsMap = await hitlApi.versions.getStepsToUIVersionsMap();
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* ```typescript
|
|
83
|
+
* const stepToUIVesionsMap = await hitlApi.versions.getStepsToUIVersionsMap({ stepName });
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
86
|
+
* @remarks
|
|
87
|
+
* Makes a GET request to the `/ui-versions/steps-to-ui-map` endpoint
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
10
90
|
static getStepsToUIVersionsMap({ stepName, ...options }: GetStepsToUIVersionsMapOptions): Promise<object>;
|
|
11
91
|
}
|
|
12
92
|
//# sourceMappingURL=Versions.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Versions.d.ts","sourceRoot":"","sources":["../../../src/api/Versions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,8BAA8B,EAC/B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"Versions.d.ts","sourceRoot":"","sources":["../../../src/api/Versions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,8BAA8B,EAC/B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;;;;;;GAcG;AACH,qBAAa,QAAS,SAAQ,QAAQ;IACpC,SAAS,CAAC,MAAM,CAAC,UAAU,SAAiB;IAC5C,SAAS,CAAC,MAAM,CAAC,YAAY,SAAkB;IAC/C,SAAS,CAAC,MAAM,CAAC,wBAAwB,SAAqB;IAE9D;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,eAAe,CACjC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,uBAAuB,CAAC;IASnC;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,cAAc,CAChC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,sBAAsB,CAAC;IAUlC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,uBAAuB,CACzC,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,8BAA8B,GACvD,OAAO,CAAC,MAAM,CAAC;CAUnB"}
|
|
@@ -17,5 +17,5 @@ export { Versions } from './Versions';
|
|
|
17
17
|
export { Tasks } from './Tasks';
|
|
18
18
|
export { SessionRelations } from './SessionRelations';
|
|
19
19
|
export { Contacts } from './Contacts';
|
|
20
|
-
export {
|
|
20
|
+
export { DraftMessages } from './DraftMessages';
|
|
21
21
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC"}
|
|
@@ -51,7 +51,10 @@ export interface SetAgentStatusOptions extends ApiVersionOptions, NoAccountId<Ag
|
|
|
51
51
|
export interface UpdateAgentsStatusByQueryOptions extends ApiVersionOptions, NoAccountId<Agents.IUpdateAgentsStatusQuery>, Agents.IUpdateAgentsStatusBody {
|
|
52
52
|
readonly maxRetries?: number;
|
|
53
53
|
}
|
|
54
|
+
/** Agent status enumeration defining possible states of an agent */
|
|
54
55
|
export { AGENT_STATUS };
|
|
56
|
+
/** Events that can be broadcast related to agents */
|
|
55
57
|
export { AGENT_BROADCAST_EVENTS };
|
|
58
|
+
/** Available user role types */
|
|
56
59
|
export { USER_ROLE };
|
|
57
60
|
//# sourceMappingURL=agents.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../../src/types/agents.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,YAAY,EACZ,sBAAsB,EACtB,SAAS,EACV,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAG1D,MAAM,WAAW,WAAY,SAAQ,MAAM,CAAC,WAAW;CAAG;AAC1D,MAAM,WAAW,qBAAsB,SAAQ,MAAM,CAAC,sBAAsB;CAAG;AAE/E,MAAM,WAAW,KAAM,SAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3D,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,WAAW,CAAC;CACzB;AACD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC,MAAM,WAAW,0BAA2B,SAAQ,MAAM,CAAC,oBAAoB;CAAG;AAElF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACd,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;CACH;AAED,MAAM,WAAW,gBACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC;CAAG;AAE5C,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,2BACf,SAAQ,iBAAiB,EACvB,MAAM,CAAC,2BAA2B,EAClC,WAAW,CAAC,MAAM,CAAC,0BAA0B,CAAC;CAAE;AAEpD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,mBACf,SAAQ,iBAAiB,EACvB,MAAM,CAAC,iBAAiB;IAC1B,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,mBACf,SAAQ,OAAO,CAAC,KAAK,CAAC;CAAE;AAC1B,MAAM,WAAW,kBACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,EAClC,MAAM,CAAC,aAAa;CAAE;AAE1B,MAAM,WAAW,6BACf,SAAQ,OAAO,CAAC,KAAK,CAAC;CAAE;AAC1B,MAAM,WAAW,4BACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,0BAA0B,CAAC;CAAE;AAGpD,MAAM,WAAW,sBAAuB,SAAQ,MAAM,CAAC,WAAW;CAAG;AACrE,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAsB,SACrC,iBAAiB,EACjB,WAAW,CAAC,MAAM,CAAC,oBAAoB,CAAC,EACxC,MAAM,CAAC,mBAAmB;IACxB,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD,UAAU,EAAE,WAAW,CAAA;CACxB;AAEH,MAAM,WAAW,gCAAiC,SAChD,iBAAiB,EACjB,WAAW,CAAC,MAAM,CAAC,wBAAwB,CAAC,EAC5C,MAAM,CAAC,uBAAuB;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;
|
|
1
|
+
{"version":3,"file":"agents.d.ts","sourceRoot":"","sources":["../../../src/types/agents.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,YAAY,EACZ,sBAAsB,EACtB,SAAS,EACV,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAG1D,MAAM,WAAW,WAAY,SAAQ,MAAM,CAAC,WAAW;CAAG;AAC1D,MAAM,WAAW,qBAAsB,SAAQ,MAAM,CAAC,sBAAsB;CAAG;AAE/E,MAAM,WAAW,KAAM,SAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3D,IAAI,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,WAAW,CAAC;CACzB;AACD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC,MAAM,WAAW,0BAA2B,SAAQ,MAAM,CAAC,oBAAoB;CAAG;AAElF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACd,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;KAC7B,CAAC;CACH;AAED,MAAM,WAAW,gBACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC;CAAG;AAE5C,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,2BACf,SAAQ,iBAAiB,EACvB,MAAM,CAAC,2BAA2B,EAClC,WAAW,CAAC,MAAM,CAAC,0BAA0B,CAAC;CAAE;AAEpD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,mBACf,SAAQ,iBAAiB,EACvB,MAAM,CAAC,iBAAiB;IAC1B,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,mBACf,SAAQ,OAAO,CAAC,KAAK,CAAC;CAAE;AAC1B,MAAM,WAAW,kBACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,EAClC,MAAM,CAAC,aAAa;CAAE;AAE1B,MAAM,WAAW,6BACf,SAAQ,OAAO,CAAC,KAAK,CAAC;CAAE;AAC1B,MAAM,WAAW,4BACf,SAAQ,iBAAiB,EACvB,WAAW,CAAC,MAAM,CAAC,0BAA0B,CAAC;CAAE;AAGpD,MAAM,WAAW,sBAAuB,SAAQ,MAAM,CAAC,WAAW;CAAG;AACrE,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAsB,SACrC,iBAAiB,EACjB,WAAW,CAAC,MAAM,CAAC,oBAAoB,CAAC,EACxC,MAAM,CAAC,mBAAmB;IACxB,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD,UAAU,EAAE,WAAW,CAAA;CACxB;AAEH,MAAM,WAAW,gCAAiC,SAChD,iBAAiB,EACjB,WAAW,CAAC,MAAM,CAAC,wBAAwB,CAAC,EAC5C,MAAM,CAAC,uBAAuB;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,oEAAoE;AACpE,OAAO,EAAE,YAAY,EAAE,CAAC;AAExB,qDAAqD;AACrD,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAElC,gCAAgC;AAChC,OAAO,EAAE,SAAS,EAAE,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { DraftMessages } from '@onereach/types-hitl-api';
|
|
2
|
+
import { ApiVersionOptions, NoAccountId } from './common';
|
|
3
|
+
export interface DraftMessage extends DraftMessages.IDraftMessage {
|
|
4
|
+
}
|
|
5
|
+
export interface GetDraftMessagesOptions extends ApiVersionOptions, NoAccountId<DraftMessages.IGetDraftMessagesQuery> {
|
|
6
|
+
}
|
|
7
|
+
export interface GetDraftMessagesResponse extends DraftMessages.IGetDraftMessagesResponse {
|
|
8
|
+
data: DraftMessage[];
|
|
9
|
+
}
|
|
10
|
+
export interface CreateDraftMessageOptions extends ApiVersionOptions, DraftMessages.ICreateDraftMessageBody {
|
|
11
|
+
}
|
|
12
|
+
export interface UpdateDraftMessageOptions extends ApiVersionOptions, DraftMessages.IUpdateDraftMessageBody {
|
|
13
|
+
}
|
|
14
|
+
export interface DeleteDraftMessageOptions extends ApiVersionOptions, NoAccountId<DraftMessages.IDeleteDraftMessageQuery> {
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=draft-messages.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"draft-messages.d.ts","sourceRoot":"","sources":["../../../src/types/draft-messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEzD,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAG1D,MAAM,WAAW,YAAa,SAAQ,aAAa,CAAC,aAAa;CAAG;AAEpE,MAAM,WAAW,uBAAwB,SAAQ,iBAAiB,EAChE,WAAW,CAAC,aAAa,CAAC,sBAAsB,CAAC;CAAG;AAEtD,MAAM,WAAW,wBACf,SAAQ,aAAa,CAAC,yBAAyB;IAC/C,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAClE,aAAa,CAAC,uBAAuB;CAAG;AAE1C,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAClE,aAAa,CAAC,uBAAuB;CAAG;AAE1C,MAAM,WAAW,yBAA0B,SAAQ,iBAAiB,EAClE,WAAW,CAAC,aAAa,CAAC,wBAAwB,CAAC;CAAG"}
|
|
@@ -18,5 +18,5 @@ export * as Versions from './versions';
|
|
|
18
18
|
export * as Tasks from './tasks';
|
|
19
19
|
export * as SessionRelations from './session-relations';
|
|
20
20
|
export * as Contacts from './contacts';
|
|
21
|
-
export * as
|
|
21
|
+
export * as DraftMessages from './draft-messages';
|
|
22
22
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,aAAa,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,cAAc,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,aAAa,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,gBAAgB,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,aAAa,MAAM,kBAAkB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@or-sdk/hitl",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.38.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"dev": "pnpm build:watch:esm"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@onereach/types-hitl-api": "1.0.6-rc.
|
|
21
|
+
"@onereach/types-hitl-api": "1.0.6-rc.14",
|
|
22
22
|
"@or-sdk/base": "^0.44.2",
|
|
23
23
|
"urijs": "^1.19.8"
|
|
24
24
|
},
|
|
@@ -30,5 +30,5 @@
|
|
|
30
30
|
"publishConfig": {
|
|
31
31
|
"access": "public"
|
|
32
32
|
},
|
|
33
|
-
"gitHead": "
|
|
33
|
+
"gitHead": "17ab4bfa20b79b20348db301c63b3e900895ff52"
|
|
34
34
|
}
|
package/src/HITL.ts
CHANGED
|
@@ -20,7 +20,7 @@ import {
|
|
|
20
20
|
Tasks,
|
|
21
21
|
SessionRelations,
|
|
22
22
|
Contacts,
|
|
23
|
-
|
|
23
|
+
DraftMessages,
|
|
24
24
|
} from './api';
|
|
25
25
|
import { AppError } from './AppError';
|
|
26
26
|
import { SERVICE_KEY } from './constants';
|
|
@@ -54,7 +54,7 @@ export class HITL extends Base {
|
|
|
54
54
|
public readonly tasks: typeof Tasks;
|
|
55
55
|
public readonly sessionRelations: typeof SessionRelations;
|
|
56
56
|
public readonly contacts: typeof Contacts;
|
|
57
|
-
public readonly
|
|
57
|
+
public readonly draftMessages: typeof DraftMessages;
|
|
58
58
|
|
|
59
59
|
/**
|
|
60
60
|
* ```typescript
|
|
@@ -91,7 +91,7 @@ export class HITL extends Base {
|
|
|
91
91
|
this.tasks = Tasks.configure(request);
|
|
92
92
|
this.sessionRelations = SessionRelations.configure(request);
|
|
93
93
|
this.contacts = Contacts.configure(request);
|
|
94
|
-
this.
|
|
94
|
+
this.draftMessages = DraftMessages.configure(request);
|
|
95
95
|
}
|
|
96
96
|
|
|
97
97
|
public parseError(e: AxiosError<AppErrorObject>): AppError {
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
import { DEFAULT_OMIT_FIELDS } from '../constants';
|
|
2
2
|
import {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
} from '../types/
|
|
3
|
+
DraftMessage,
|
|
4
|
+
GetDraftMessagesOptions,
|
|
5
|
+
GetDraftMessagesResponse,
|
|
6
|
+
CreateDraftMessageOptions,
|
|
7
|
+
UpdateDraftMessageOptions,
|
|
8
|
+
DeleteDraftMessageOptions,
|
|
9
|
+
} from '../types/draft-messages';
|
|
10
10
|
|
|
11
11
|
import { HITLBase } from './HITLBase';
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
* Manages
|
|
14
|
+
* Manages draft messages in the system
|
|
15
15
|
*
|
|
16
|
-
* This class provides functionality to create, retrieve, update, and delete
|
|
17
|
-
*
|
|
16
|
+
* This class provides functionality to create, retrieve, update, and delete draft messages.
|
|
17
|
+
* Draft messages are messages that can be sent at a specific time to contacts and sessions.
|
|
18
18
|
*
|
|
19
19
|
* Key features:
|
|
20
20
|
* - Schedule messages for future delivery
|
|
@@ -24,13 +24,13 @@ import { HITLBase } from './HITLBase';
|
|
|
24
24
|
* @example
|
|
25
25
|
* Basic usage:
|
|
26
26
|
* ```typescript
|
|
27
|
-
* // Get all
|
|
28
|
-
* const messages = await hitlApi.
|
|
27
|
+
* // Get all draft messages
|
|
28
|
+
* const messages = await hitlApi.draftMessages.getDraftMessages();
|
|
29
29
|
*
|
|
30
|
-
* // Create a new
|
|
31
|
-
* const newMessage = await hitlApi.
|
|
30
|
+
* // Create a new draft message
|
|
31
|
+
* const newMessage = await hitlApi.draftMessages.createDraftMessage({
|
|
32
32
|
* message: {
|
|
33
|
-
* message: 'Hello! This is a
|
|
33
|
+
* message: 'Hello! This is a draft message.',
|
|
34
34
|
* media: []
|
|
35
35
|
* },
|
|
36
36
|
* type: 'SMS',
|
|
@@ -40,41 +40,41 @@ import { HITLBase } from './HITLBase';
|
|
|
40
40
|
* ```
|
|
41
41
|
*
|
|
42
42
|
* @remarks
|
|
43
|
-
* - All methods in this class interact with the `/
|
|
43
|
+
* - All methods in this class interact with the `/draft-messages` endpoint
|
|
44
44
|
* - These methods are available only when you pass `{ version: 1 }` in the parameters.
|
|
45
45
|
* @public
|
|
46
46
|
*/
|
|
47
47
|
|
|
48
|
-
export class
|
|
49
|
-
protected static MODULE_URL = '
|
|
48
|
+
export class DraftMessages extends HITLBase {
|
|
49
|
+
protected static MODULE_URL = 'draft-messages';
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
* Gets a list of
|
|
52
|
+
* Gets a list of draft messages
|
|
53
53
|
*
|
|
54
|
-
* @param options - Configuration parameters for the
|
|
54
|
+
* @param options - Configuration parameters for the draft messages list request
|
|
55
55
|
*
|
|
56
56
|
* Optional parameters:
|
|
57
|
-
* - `id` - (string) Get specific
|
|
57
|
+
* - `id` - (string) Get specific draft message by ID
|
|
58
58
|
* - `timeout` - (number) Request timeout in milliseconds
|
|
59
59
|
* - `version` - (string | number) API version to use
|
|
60
60
|
*
|
|
61
|
-
* @returns {Promise<
|
|
62
|
-
* - `data` - Array of
|
|
61
|
+
* @returns {Promise<GetDraftMessagesResponse | DraftMessage>} Promise resolving to:
|
|
62
|
+
* - `data` - Array of draft message objects {@link DraftMessage}
|
|
63
63
|
*
|
|
64
64
|
* @example
|
|
65
65
|
* ```typescript
|
|
66
|
-
* const response = await hitlApi.
|
|
66
|
+
* const response = await hitlApi.draftMessages.getDraftMessages({
|
|
67
67
|
* id: 'message-id-1'
|
|
68
68
|
* });
|
|
69
69
|
* ```
|
|
70
70
|
*
|
|
71
71
|
* @remarks
|
|
72
|
-
* Makes a GET request to the `/
|
|
72
|
+
* Makes a GET request to the `/draft-messages` endpoint
|
|
73
73
|
* @public
|
|
74
74
|
*/
|
|
75
|
-
public static async
|
|
76
|
-
options:
|
|
77
|
-
): Promise<
|
|
75
|
+
public static async getDraftMessages(
|
|
76
|
+
options: GetDraftMessagesOptions = {},
|
|
77
|
+
): Promise<GetDraftMessagesResponse | DraftMessage> {
|
|
78
78
|
const route = this.getBaseUrl(options);
|
|
79
79
|
const params = Object.fromEntries(
|
|
80
80
|
Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
|
|
@@ -89,13 +89,13 @@ export class ScheduledMessages extends HITLBase {
|
|
|
89
89
|
}
|
|
90
90
|
|
|
91
91
|
/**
|
|
92
|
-
* Creates a new
|
|
92
|
+
* Creates a new draft message
|
|
93
93
|
*
|
|
94
|
-
* @param options - Configuration parameters for creating the
|
|
94
|
+
* @param options - Configuration parameters for creating the draft message
|
|
95
95
|
*
|
|
96
96
|
* Required parameters:
|
|
97
97
|
* - `message` - (Message) Message content and media
|
|
98
|
-
* - `type` - (string) Type of the
|
|
98
|
+
* - `type` - (string) Type of the draft message
|
|
99
99
|
* - `contactIds` - (string[]) Array of contact IDs to send the message to
|
|
100
100
|
* - `timestamp` - (Date) When the message should be sent
|
|
101
101
|
*
|
|
@@ -105,11 +105,11 @@ export class ScheduledMessages extends HITLBase {
|
|
|
105
105
|
* - `timeout` - (number) Request timeout in milliseconds
|
|
106
106
|
* - `version` - (string | number) API version to use
|
|
107
107
|
*
|
|
108
|
-
* @returns {Promise<
|
|
108
|
+
* @returns {Promise<DraftMessage>} Promise resolving to the created draft message
|
|
109
109
|
*
|
|
110
110
|
* @example
|
|
111
111
|
* ```typescript
|
|
112
|
-
* const newMessage = await hitlApi.
|
|
112
|
+
* const newMessage = await hitlApi.draftMessages.createDraftMessage({
|
|
113
113
|
* message: {
|
|
114
114
|
* message: 'Your appointment is tomorrow at 3 PM',
|
|
115
115
|
* media: [
|
|
@@ -127,12 +127,12 @@ export class ScheduledMessages extends HITLBase {
|
|
|
127
127
|
* ```
|
|
128
128
|
*
|
|
129
129
|
* @remarks
|
|
130
|
-
* Makes a POST request to the `/
|
|
130
|
+
* Makes a POST request to the `/draft-messages` endpoint
|
|
131
131
|
* @public
|
|
132
132
|
*/
|
|
133
|
-
public static async
|
|
134
|
-
options:
|
|
135
|
-
): Promise<
|
|
133
|
+
public static async createDraftMessage(
|
|
134
|
+
options: CreateDraftMessageOptions,
|
|
135
|
+
): Promise<DraftMessage> {
|
|
136
136
|
const route = this.getBaseUrl(options);
|
|
137
137
|
const data = Object.fromEntries(
|
|
138
138
|
Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
|
|
@@ -147,16 +147,16 @@ export class ScheduledMessages extends HITLBase {
|
|
|
147
147
|
}
|
|
148
148
|
|
|
149
149
|
/**
|
|
150
|
-
* Updates an existing
|
|
150
|
+
* Updates an existing draft message
|
|
151
151
|
*
|
|
152
|
-
* @param options - Configuration parameters for updating the
|
|
152
|
+
* @param options - Configuration parameters for updating the draft message
|
|
153
153
|
*
|
|
154
154
|
* Required parameters:
|
|
155
155
|
* - `id` - (string) Unique identifier of the message to update
|
|
156
156
|
*
|
|
157
157
|
* Optional parameters:
|
|
158
158
|
* - `message` - (Message) Updated message content and media
|
|
159
|
-
* - `type` - (string) Updated type of the
|
|
159
|
+
* - `type` - (string) Updated type of the draft message
|
|
160
160
|
* - `contactIds` - (string[]) Updated array of contact IDs
|
|
161
161
|
* - `sessionId` - (string) Updated session ID
|
|
162
162
|
* - `toIdentifier` - (string) Updated identifier for message targeting
|
|
@@ -170,11 +170,11 @@ export class ScheduledMessages extends HITLBase {
|
|
|
170
170
|
* - `agentId` - (string) Agent who created the message
|
|
171
171
|
* - `status` - (string) Current status of the message
|
|
172
172
|
*
|
|
173
|
-
* @returns {Promise<
|
|
173
|
+
* @returns {Promise<DraftMessage>} Promise resolving to the updated draft message
|
|
174
174
|
*
|
|
175
175
|
* @example
|
|
176
176
|
* ```typescript
|
|
177
|
-
* const updatedMessage = await hitlApi.
|
|
177
|
+
* const updatedMessage = await hitlApi.draftMessages.updateDraftMessage({
|
|
178
178
|
* id: "msg-id-1",
|
|
179
179
|
* message: {
|
|
180
180
|
* message: "Updated reminder: Your appointment is at 4 PM",
|
|
@@ -185,12 +185,12 @@ export class ScheduledMessages extends HITLBase {
|
|
|
185
185
|
* ```
|
|
186
186
|
*
|
|
187
187
|
* @remarks
|
|
188
|
-
* Makes a PUT request to the `/
|
|
188
|
+
* Makes a PUT request to the `/draft-messages` endpoint
|
|
189
189
|
* @public
|
|
190
190
|
*/
|
|
191
|
-
public static async
|
|
192
|
-
options:
|
|
193
|
-
): Promise<
|
|
191
|
+
public static async updateDraftMessage(
|
|
192
|
+
options: UpdateDraftMessageOptions,
|
|
193
|
+
): Promise<DraftMessage> {
|
|
194
194
|
const route = this.getBaseUrl(options);
|
|
195
195
|
const data = Object.fromEntries(
|
|
196
196
|
Object.entries(options).filter(([key]) => !DEFAULT_OMIT_FIELDS.includes(key)),
|
|
@@ -205,9 +205,9 @@ export class ScheduledMessages extends HITLBase {
|
|
|
205
205
|
}
|
|
206
206
|
|
|
207
207
|
/**
|
|
208
|
-
* Deletes a
|
|
208
|
+
* Deletes a draft message
|
|
209
209
|
*
|
|
210
|
-
* @param options - Configuration parameters for deleting the
|
|
210
|
+
* @param options - Configuration parameters for deleting the draft message
|
|
211
211
|
*
|
|
212
212
|
* Required parameters:
|
|
213
213
|
* - `id` - (string) Unique identifier of the message to delete
|
|
@@ -220,17 +220,17 @@ export class ScheduledMessages extends HITLBase {
|
|
|
220
220
|
*
|
|
221
221
|
* @example
|
|
222
222
|
* ```typescript
|
|
223
|
-
* await hitlApi.
|
|
223
|
+
* await hitlApi.draftMessages.deleteDraftMessage({
|
|
224
224
|
* id: "msg-id-1"
|
|
225
225
|
* });
|
|
226
226
|
* ```
|
|
227
227
|
*
|
|
228
228
|
* @remarks
|
|
229
|
-
* Makes a DELETE request to the `/
|
|
229
|
+
* Makes a DELETE request to the `/draft-messages` endpoint
|
|
230
230
|
* @public
|
|
231
231
|
*/
|
|
232
|
-
public static async
|
|
233
|
-
{ id, ...options }:
|
|
232
|
+
public static async deleteDraftMessage(
|
|
233
|
+
{ id, ...options }: DeleteDraftMessageOptions,
|
|
234
234
|
): Promise<void> {
|
|
235
235
|
const route = this.getBaseUrl(options);
|
|
236
236
|
|
package/src/api/index.ts
CHANGED
|
@@ -17,4 +17,4 @@ export { Versions } from './Versions';
|
|
|
17
17
|
export { Tasks } from './Tasks';
|
|
18
18
|
export { SessionRelations } from './SessionRelations';
|
|
19
19
|
export { Contacts } from './Contacts';
|
|
20
|
-
export {
|
|
20
|
+
export { DraftMessages } from './DraftMessages';
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { DraftMessages } from '@onereach/types-hitl-api';
|
|
2
|
+
|
|
3
|
+
import { ApiVersionOptions, NoAccountId } from './common';
|
|
4
|
+
|
|
5
|
+
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
|
6
|
+
export interface DraftMessage extends DraftMessages.IDraftMessage {}
|
|
7
|
+
|
|
8
|
+
export interface GetDraftMessagesOptions extends ApiVersionOptions,
|
|
9
|
+
NoAccountId<DraftMessages.IGetDraftMessagesQuery> {}
|
|
10
|
+
|
|
11
|
+
export interface GetDraftMessagesResponse
|
|
12
|
+
extends DraftMessages.IGetDraftMessagesResponse {
|
|
13
|
+
data: DraftMessage[];
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export interface CreateDraftMessageOptions extends ApiVersionOptions,
|
|
17
|
+
DraftMessages.ICreateDraftMessageBody {}
|
|
18
|
+
|
|
19
|
+
export interface UpdateDraftMessageOptions extends ApiVersionOptions,
|
|
20
|
+
DraftMessages.IUpdateDraftMessageBody {}
|
|
21
|
+
|
|
22
|
+
export interface DeleteDraftMessageOptions extends ApiVersionOptions,
|
|
23
|
+
NoAccountId<DraftMessages.IDeleteDraftMessageQuery> {}
|
package/src/types/index.ts
CHANGED
|
@@ -18,4 +18,4 @@ export * as Versions from './versions';
|
|
|
18
18
|
export * as Tasks from './tasks';
|
|
19
19
|
export * as SessionRelations from './session-relations';
|
|
20
20
|
export * as Contacts from './contacts';
|
|
21
|
-
export * as
|
|
21
|
+
export * as DraftMessages from './draft-messages';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ScheduledMessages.js","sourceRoot":"","sources":["../../../src/api/ScheduledMessages.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAAmD;AAUnD,uCAAsC;AAqCtC;IAAuC,qCAAQ;IAA/C;;IAoMA,CAAC;IAzKqB,sCAAoB,GAAxC;4DACE,OAAyC;;YAAzC,wBAAA,EAAA,YAAyC;;gBAEnC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBACjC,MAAM,GAAG,MAAM,CAAC,WAAW,CAC/B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,UAAC,EAAK;wBAAJ,GAAG,QAAA;oBAAM,OAAA,CAAC,+BAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAlC,CAAkC,CAAC,CAC9E,CAAC;gBAEF,WAAO,IAAI,CAAC,OAAO,YACjB,MAAM,EAAE,KAAK,EACb,KAAK,OAAA,EACL,MAAM,QAAA,IACH,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAChC,EAAC;;;KACJ;IA4CmB,wCAAsB,GAA1C,UACE,OAAsC;;;;gBAEhC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBACjC,IAAI,GAAG,MAAM,CAAC,WAAW,CAC7B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,UAAC,EAAK;wBAAJ,GAAG,QAAA;oBAAM,OAAA,CAAC,+BAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAlC,CAAkC,CAAC,CAC9E,CAAC;gBAEF,WAAO,IAAI,CAAC,OAAO,YACjB,MAAM,EAAE,MAAM,EACd,KAAK,OAAA,EACL,IAAI,MAAA,IACD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAChC,EAAC;;;KACJ;IA4CmB,wCAAsB,GAA1C,UACE,OAAsC;;;;gBAEhC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBACjC,IAAI,GAAG,MAAM,CAAC,WAAW,CAC7B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,UAAC,EAAK;wBAAJ,GAAG,QAAA;oBAAM,OAAA,CAAC,+BAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAlC,CAAkC,CAAC,CAC9E,CAAC;gBAEF,WAAO,IAAI,CAAC,OAAO,YACjB,MAAM,EAAE,KAAK,EACb,KAAK,OAAA,EACL,IAAI,MAAA,IACD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAChC,EAAC;;;KACJ;IA2BmB,wCAAsB,GAA1C,UACE,EAAiD;;;YAA/C,IAAA,EAAE,QAAA,EAAK,OAAO,cAAhB,MAAkB,CAAF;;gBAEV,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;gBAEvC,WAAO,IAAI,CAAC,OAAO,YACjB,MAAM,EAAE,QAAQ,EAChB,KAAK,OAAA,EACL,MAAM,EAAE,EAAE,EAAE,IAAA,EAAE,IACX,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAChC,EAAC;;;KACJ;IAlMgB,4BAAU,GAAG,oBAAoB,CAAC;IAmMrD,wBAAC;CAAA,AApMD,CAAuC,mBAAQ,GAoM9C;AApMY,8CAAiB"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"scheduled-messages.js","sourceRoot":"","sources":["../../../src/types/scheduled-messages.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ScheduledMessages.js","sourceRoot":"","sources":["../../../src/api/ScheduledMessages.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAUnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAqCtC,MAAM,OAAO,iBAAkB,SAAQ,QAAQ;IA2BtC,MAAM,CAAO,oBAAoB;6DACtC,UAAuC,EAAE;YAEzC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAC/B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAC9E,CAAC;YAEF,OAAO,IAAI,CAAC,OAAO,iBACjB,MAAM,EAAE,KAAK,EACb,KAAK;gBACL,MAAM,IACH,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAChC,CAAC;QACL,CAAC;KAAA;IA4CM,MAAM,CAAO,sBAAsB,CACxC,OAAsC;;YAEtC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAC7B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAC9E,CAAC;YAEF,OAAO,IAAI,CAAC,OAAO,iBACjB,MAAM,EAAE,MAAM,EACd,KAAK;gBACL,IAAI,IACD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAChC,CAAC;QACL,CAAC;KAAA;IA4CM,MAAM,CAAO,sBAAsB,CACxC,OAAsC;;YAEtC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAC7B,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAC9E,CAAC;YAEF,OAAO,IAAI,CAAC,OAAO,iBACjB,MAAM,EAAE,KAAK,EACb,KAAK;gBACL,IAAI,IACD,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAChC,CAAC;QACL,CAAC;KAAA;IA2BM,MAAM,CAAO,sBAAsB,CACxC,EAAiD;;gBAAjD,EAAE,EAAE,OAA6C,EAAxC,OAAO,cAAhB,MAAkB,CAAF;YAEhB,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAEvC,OAAO,IAAI,CAAC,OAAO,iBACjB,MAAM,EAAE,QAAQ,EAChB,KAAK,EACL,MAAM,EAAE,EAAE,EAAE,EAAE,IACX,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,EAChC,CAAC;QACL,CAAC;KAAA;;AAlMgB,4BAAU,GAAG,oBAAoB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"scheduled-messages.js","sourceRoot":"","sources":["../../../src/types/scheduled-messages.ts"],"names":[],"mappings":""}
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { ScheduledMessage, GetScheduledMessagesOptions, GetScheduledMessagesResponse, CreateScheduledMessageOptions, UpdateScheduledMessageOptions, DeleteScheduledMessageOptions } from '../types/scheduled-messages';
|
|
2
|
-
import { HITLBase } from './HITLBase';
|
|
3
|
-
export declare class ScheduledMessages extends HITLBase {
|
|
4
|
-
protected static MODULE_URL: string;
|
|
5
|
-
static getScheduledMessages(options?: GetScheduledMessagesOptions): Promise<GetScheduledMessagesResponse | ScheduledMessage>;
|
|
6
|
-
static createScheduledMessage(options: CreateScheduledMessageOptions): Promise<ScheduledMessage>;
|
|
7
|
-
static updateScheduledMessage(options: UpdateScheduledMessageOptions): Promise<ScheduledMessage>;
|
|
8
|
-
static deleteScheduledMessage({ id, ...options }: DeleteScheduledMessageOptions): Promise<void>;
|
|
9
|
-
}
|
|
10
|
-
//# sourceMappingURL=ScheduledMessages.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ScheduledMessages.d.ts","sourceRoot":"","sources":["../../../src/api/ScheduledMessages.ts"],"names":[],"mappings":"AACA,OAAO,EACL,gBAAgB,EAChB,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,6BAA6B,EAC9B,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAqCtC,qBAAa,iBAAkB,SAAQ,QAAQ;IAC7C,SAAS,CAAC,MAAM,CAAC,UAAU,SAAwB;WA0B/B,oBAAoB,CACtC,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,GAAG,gBAAgB,CAAC;WAwDvC,sBAAsB,CACxC,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,gBAAgB,CAAC;WAwDR,sBAAsB,CACxC,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,gBAAgB,CAAC;WAuCR,sBAAsB,CACxC,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,EAAE,6BAA6B,GAChD,OAAO,CAAC,IAAI,CAAC;CAUjB"}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { ScheduledMessages } from '@onereach/types-hitl-api';
|
|
2
|
-
import { ApiVersionOptions, NoAccountId } from './common';
|
|
3
|
-
export interface ScheduledMessage extends ScheduledMessages.IScheduledMessage {
|
|
4
|
-
}
|
|
5
|
-
export interface GetScheduledMessagesOptions extends ApiVersionOptions, NoAccountId<ScheduledMessages.IGetScheduledMessagesQuery> {
|
|
6
|
-
}
|
|
7
|
-
export interface GetScheduledMessagesResponse extends ScheduledMessages.IGetScheduledMessagesResponse {
|
|
8
|
-
data: ScheduledMessage[];
|
|
9
|
-
}
|
|
10
|
-
export interface CreateScheduledMessageOptions extends ApiVersionOptions, ScheduledMessages.ICreateScheduledMessageBody {
|
|
11
|
-
}
|
|
12
|
-
export interface UpdateScheduledMessageOptions extends ApiVersionOptions, ScheduledMessages.IUpdateScheduledMessageBody {
|
|
13
|
-
}
|
|
14
|
-
export interface DeleteScheduledMessageOptions extends ApiVersionOptions, NoAccountId<ScheduledMessages.IDeleteScheduledMessageQuery> {
|
|
15
|
-
}
|
|
16
|
-
//# sourceMappingURL=scheduled-messages.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"scheduled-messages.d.ts","sourceRoot":"","sources":["../../../src/types/scheduled-messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAG1D,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,CAAC,iBAAiB;CAAG;AAEhF,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB,EACpE,WAAW,CAAC,iBAAiB,CAAC,0BAA0B,CAAC;CAAG;AAE9D,MAAM,WAAW,4BACf,SAAQ,iBAAiB,CAAC,6BAA6B;IACvD,IAAI,EAAE,gBAAgB,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB,EACtE,iBAAiB,CAAC,2BAA2B;CAAG;AAElD,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB,EACtE,iBAAiB,CAAC,2BAA2B;CAAG;AAElD,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB,EACtE,WAAW,CAAC,iBAAiB,CAAC,4BAA4B,CAAC;CAAG"}
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { ScheduledMessages } from '@onereach/types-hitl-api';
|
|
2
|
-
|
|
3
|
-
import { ApiVersionOptions, NoAccountId } from './common';
|
|
4
|
-
|
|
5
|
-
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
|
6
|
-
export interface ScheduledMessage extends ScheduledMessages.IScheduledMessage {}
|
|
7
|
-
|
|
8
|
-
export interface GetScheduledMessagesOptions extends ApiVersionOptions,
|
|
9
|
-
NoAccountId<ScheduledMessages.IGetScheduledMessagesQuery> {}
|
|
10
|
-
|
|
11
|
-
export interface GetScheduledMessagesResponse
|
|
12
|
-
extends ScheduledMessages.IGetScheduledMessagesResponse {
|
|
13
|
-
data: ScheduledMessage[];
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
export interface CreateScheduledMessageOptions extends ApiVersionOptions,
|
|
17
|
-
ScheduledMessages.ICreateScheduledMessageBody {}
|
|
18
|
-
|
|
19
|
-
export interface UpdateScheduledMessageOptions extends ApiVersionOptions,
|
|
20
|
-
ScheduledMessages.IUpdateScheduledMessageBody {}
|
|
21
|
-
|
|
22
|
-
export interface DeleteScheduledMessageOptions extends ApiVersionOptions,
|
|
23
|
-
NoAccountId<ScheduledMessages.IDeleteScheduledMessageQuery> {}
|