@opens/gateways 1.11.5 → 1.11.6

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.
@@ -0,0 +1,126 @@
1
+ /** Supported Elasticsearch indexes for contact history queries. */
2
+ type ContactHistoryIndex = 'chat' | 'cdr';
3
+ /** Sort order for contact history results. */
4
+ type ContactHistorySortOrder = 'asc' | 'desc';
5
+ /** Query parameters for listing contact interaction history across indexes. */
6
+ interface ListContactHistoryRequest {
7
+ companyId?: string;
8
+ contactIds?: string[];
9
+ indexes?: ContactHistoryIndex[];
10
+ operatorIds?: string[];
11
+ chatStatus?: string[];
12
+ chatProviders?: string[];
13
+ currentScore?: number;
14
+ searchAfter?: string[];
15
+ queueIds?: string[];
16
+ order?: ContactHistorySortOrder;
17
+ limit?: number;
18
+ }
19
+ /** Member associated with a contact interaction. */
20
+ interface InteractionMemberResponse {
21
+ id: number;
22
+ recipientId: string;
23
+ provider: string;
24
+ chatRoomId: number;
25
+ origin: string;
26
+ channel: string;
27
+ companyId: string;
28
+ }
29
+ /** Chat routing step recorded for a contact interaction. */
30
+ interface InteractionChatStepResponse {
31
+ id: string;
32
+ chatRoomId: number;
33
+ duration: number;
34
+ actionId: string;
35
+ queueId: unknown;
36
+ nextQueueId: unknown;
37
+ wasTransferred: unknown;
38
+ createdAt: string;
39
+ updatedAt: string;
40
+ }
41
+ /** Organization linked to a contact interaction. */
42
+ interface InteractionOrganizationResponse {
43
+ id: number;
44
+ callId: number;
45
+ organizationId: number;
46
+ createdAt: string;
47
+ updatedAt: string;
48
+ }
49
+ /** Call step recorded for a contact interaction. */
50
+ interface InteractionCallStepResponse {
51
+ id: number;
52
+ callId: number;
53
+ companyId: string;
54
+ status: string;
55
+ fromNumber: string;
56
+ fromId: string;
57
+ contextId: string;
58
+ toNumber: string;
59
+ toId: string;
60
+ transferToNumber: unknown;
61
+ transferToId: unknown;
62
+ waitTime: number;
63
+ talkTime: number;
64
+ queue: unknown;
65
+ createdAt: string;
66
+ updatedAt: string;
67
+ hourlyTalkTime: unknown[];
68
+ hourlyWaitTime: unknown[];
69
+ }
70
+ /** Contact interaction entry returned by the Call Report API. */
71
+ interface ContactInteractionResponse {
72
+ id: number;
73
+ status?: string;
74
+ companyId: string;
75
+ currentAttendanceGroupId: unknown;
76
+ answeredAt?: string;
77
+ createdAt: string;
78
+ updatedAt: string;
79
+ waitTime?: number;
80
+ wasTransferred: unknown;
81
+ type: string;
82
+ wasFinishedSilently?: boolean;
83
+ totalTime?: number;
84
+ attendanceTime?: number;
85
+ campaignId: unknown;
86
+ chatConfigId?: string;
87
+ protocol: string;
88
+ score: unknown;
89
+ csatFeedback?: string | null;
90
+ createdBy?: string;
91
+ clientIdentifier?: string;
92
+ closedBy: unknown;
93
+ creatorProvider?: string;
94
+ subject?: string;
95
+ routedAt: unknown;
96
+ activeDates: unknown;
97
+ activeWeekDays: unknown;
98
+ members?: InteractionMemberResponse[];
99
+ tags: unknown[];
100
+ tagsGroups: unknown[];
101
+ invitations?: unknown[];
102
+ chatSteps?: InteractionChatStepResponse[];
103
+ organizations: InteractionOrganizationResponse[];
104
+ _index: string;
105
+ linkedId?: string;
106
+ callId?: string;
107
+ csatScore: unknown;
108
+ hungUpByAgent?: boolean;
109
+ sentToCsat?: boolean;
110
+ hungupAt?: string;
111
+ elasticId?: string;
112
+ widgetId: unknown;
113
+ wasCalledback: unknown;
114
+ hasCallback: unknown;
115
+ totalWaitTime?: number;
116
+ totalTalkTime?: number;
117
+ totalDuration?: number;
118
+ steps?: InteractionCallStepResponse[];
119
+ }
120
+ /** Paginated response returned by the Call Report API for multi-index history. */
121
+ interface ContactHistoryResponse {
122
+ currentScore: string[];
123
+ data: ContactInteractionResponse[];
124
+ }
125
+
126
+ export type { ContactHistoryIndex, ContactHistoryResponse, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse, ListContactHistoryRequest };
@@ -0,0 +1,126 @@
1
+ /** Supported Elasticsearch indexes for contact history queries. */
2
+ type ContactHistoryIndex = 'chat' | 'cdr';
3
+ /** Sort order for contact history results. */
4
+ type ContactHistorySortOrder = 'asc' | 'desc';
5
+ /** Query parameters for listing contact interaction history across indexes. */
6
+ interface ListContactHistoryRequest {
7
+ companyId?: string;
8
+ contactIds?: string[];
9
+ indexes?: ContactHistoryIndex[];
10
+ operatorIds?: string[];
11
+ chatStatus?: string[];
12
+ chatProviders?: string[];
13
+ currentScore?: number;
14
+ searchAfter?: string[];
15
+ queueIds?: string[];
16
+ order?: ContactHistorySortOrder;
17
+ limit?: number;
18
+ }
19
+ /** Member associated with a contact interaction. */
20
+ interface InteractionMemberResponse {
21
+ id: number;
22
+ recipientId: string;
23
+ provider: string;
24
+ chatRoomId: number;
25
+ origin: string;
26
+ channel: string;
27
+ companyId: string;
28
+ }
29
+ /** Chat routing step recorded for a contact interaction. */
30
+ interface InteractionChatStepResponse {
31
+ id: string;
32
+ chatRoomId: number;
33
+ duration: number;
34
+ actionId: string;
35
+ queueId: unknown;
36
+ nextQueueId: unknown;
37
+ wasTransferred: unknown;
38
+ createdAt: string;
39
+ updatedAt: string;
40
+ }
41
+ /** Organization linked to a contact interaction. */
42
+ interface InteractionOrganizationResponse {
43
+ id: number;
44
+ callId: number;
45
+ organizationId: number;
46
+ createdAt: string;
47
+ updatedAt: string;
48
+ }
49
+ /** Call step recorded for a contact interaction. */
50
+ interface InteractionCallStepResponse {
51
+ id: number;
52
+ callId: number;
53
+ companyId: string;
54
+ status: string;
55
+ fromNumber: string;
56
+ fromId: string;
57
+ contextId: string;
58
+ toNumber: string;
59
+ toId: string;
60
+ transferToNumber: unknown;
61
+ transferToId: unknown;
62
+ waitTime: number;
63
+ talkTime: number;
64
+ queue: unknown;
65
+ createdAt: string;
66
+ updatedAt: string;
67
+ hourlyTalkTime: unknown[];
68
+ hourlyWaitTime: unknown[];
69
+ }
70
+ /** Contact interaction entry returned by the Call Report API. */
71
+ interface ContactInteractionResponse {
72
+ id: number;
73
+ status?: string;
74
+ companyId: string;
75
+ currentAttendanceGroupId: unknown;
76
+ answeredAt?: string;
77
+ createdAt: string;
78
+ updatedAt: string;
79
+ waitTime?: number;
80
+ wasTransferred: unknown;
81
+ type: string;
82
+ wasFinishedSilently?: boolean;
83
+ totalTime?: number;
84
+ attendanceTime?: number;
85
+ campaignId: unknown;
86
+ chatConfigId?: string;
87
+ protocol: string;
88
+ score: unknown;
89
+ csatFeedback?: string | null;
90
+ createdBy?: string;
91
+ clientIdentifier?: string;
92
+ closedBy: unknown;
93
+ creatorProvider?: string;
94
+ subject?: string;
95
+ routedAt: unknown;
96
+ activeDates: unknown;
97
+ activeWeekDays: unknown;
98
+ members?: InteractionMemberResponse[];
99
+ tags: unknown[];
100
+ tagsGroups: unknown[];
101
+ invitations?: unknown[];
102
+ chatSteps?: InteractionChatStepResponse[];
103
+ organizations: InteractionOrganizationResponse[];
104
+ _index: string;
105
+ linkedId?: string;
106
+ callId?: string;
107
+ csatScore: unknown;
108
+ hungUpByAgent?: boolean;
109
+ sentToCsat?: boolean;
110
+ hungupAt?: string;
111
+ elasticId?: string;
112
+ widgetId: unknown;
113
+ wasCalledback: unknown;
114
+ hasCallback: unknown;
115
+ totalWaitTime?: number;
116
+ totalTalkTime?: number;
117
+ totalDuration?: number;
118
+ steps?: InteractionCallStepResponse[];
119
+ }
120
+ /** Paginated response returned by the Call Report API for multi-index history. */
121
+ interface ContactHistoryResponse {
122
+ currentScore: string[];
123
+ data: ContactInteractionResponse[];
124
+ }
125
+
126
+ export type { ContactHistoryIndex, ContactHistoryResponse, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse, ListContactHistoryRequest };
@@ -13,7 +13,7 @@ var __copyProps = (to, from, except, desc) => {
13
13
  };
14
14
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
15
15
 
16
- // src/integrations/contracts/index.ts
16
+ // src/call-report/contracts/index.ts
17
17
  var contracts_exports = {};
18
18
  module.exports = __toCommonJS(contracts_exports);
19
19
  //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/call-report/contracts/index.ts"],"sourcesContent":["export * from './contact-history';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
@@ -51,6 +51,12 @@ interface GetConfigsByProviderParams {
51
51
  providerName?: string;
52
52
  }
53
53
 
54
+ /** Query parameters for listing queue memberships of a member. */
55
+ interface GetMemberQueuesRequest {
56
+ memberId: string;
57
+ association?: boolean;
58
+ }
59
+ /** Queue membership entry returned by the Chat Config API. */
54
60
  interface QueueMember {
55
61
  id: string;
56
62
  memberId: string;
@@ -67,6 +73,7 @@ interface QueueMember {
67
73
  createdAt: string;
68
74
  updatedAt: string;
69
75
  queueId: string;
76
+ queue?: Queue;
70
77
  }
71
78
  type DistributionType = {
72
79
  id: string;
@@ -218,4 +225,4 @@ type RootRulesResponse = {
218
225
  data: Rule[];
219
226
  };
220
227
 
221
- export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetRootRulesRequest, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule };
228
+ export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetRootRulesRequest, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule };
@@ -51,6 +51,12 @@ interface GetConfigsByProviderParams {
51
51
  providerName?: string;
52
52
  }
53
53
 
54
+ /** Query parameters for listing queue memberships of a member. */
55
+ interface GetMemberQueuesRequest {
56
+ memberId: string;
57
+ association?: boolean;
58
+ }
59
+ /** Queue membership entry returned by the Chat Config API. */
54
60
  interface QueueMember {
55
61
  id: string;
56
62
  memberId: string;
@@ -67,6 +73,7 @@ interface QueueMember {
67
73
  createdAt: string;
68
74
  updatedAt: string;
69
75
  queueId: string;
76
+ queue?: Queue;
70
77
  }
71
78
  type DistributionType = {
72
79
  id: string;
@@ -218,4 +225,4 @@ type RootRulesResponse = {
218
225
  data: Rule[];
219
226
  };
220
227
 
221
- export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetRootRulesRequest, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule };
228
+ export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetRootRulesRequest, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule };
@@ -0,0 +1,97 @@
1
+ /** Query parameters for listing live rooms assigned to a user. */
2
+ interface ListLiveUserRoomsRequest {
3
+ recipientId: string;
4
+ companyId: string;
5
+ isOpen: boolean;
6
+ }
7
+ /** Query parameters for fetching a room by its identifier. */
8
+ interface GetRoomByIdRequest {
9
+ companyId?: string;
10
+ includeMembers?: boolean;
11
+ }
12
+ /** Date range used to determine room activity windows. */
13
+ interface RoomActiveDates {
14
+ gte: string;
15
+ lte: string;
16
+ }
17
+ /** Tag associated with a chat room. */
18
+ interface RoomTagResponse {
19
+ id: string;
20
+ chatRoomId: number;
21
+ tagId: number;
22
+ tagName: string;
23
+ companyId: string;
24
+ createdAt: string;
25
+ updatedAt: string;
26
+ }
27
+ /** Member participating in a chat room. */
28
+ interface RoomMemberResponse {
29
+ id: number;
30
+ exited: boolean;
31
+ new: boolean;
32
+ recipientId: string;
33
+ subject?: string;
34
+ origin: string;
35
+ chatRoomId: number;
36
+ externalClientId?: string;
37
+ provider: string;
38
+ providerAccessToken?: string;
39
+ channel: string;
40
+ companyId: string;
41
+ createdAt: string;
42
+ updatedAt: string;
43
+ }
44
+ /** Chat room entity returned by the Chat Webservice API. */
45
+ interface RoomResponse {
46
+ id: number;
47
+ subject: string;
48
+ companyId: string;
49
+ chatConfigId: string;
50
+ status: string;
51
+ open: boolean;
52
+ inTransfer: boolean;
53
+ closedBy: string;
54
+ latestTransferId: string;
55
+ waitTime: number;
56
+ attendanceTime: number;
57
+ score: number;
58
+ csatFeedback?: string | null;
59
+ currentRule: string;
60
+ queueId: string;
61
+ campaignId?: string;
62
+ createdBy: string;
63
+ creatorProvider: string;
64
+ lastClientMsgAt: string;
65
+ lastOperatorMsgAt: string;
66
+ createdAt: string;
67
+ updatedAt: string;
68
+ inactivityLimit: number;
69
+ wasTransferred: boolean;
70
+ wasFinishedSilently: boolean;
71
+ type: string;
72
+ answeredAt: string;
73
+ protocol: string;
74
+ activeDates: RoomActiveDates;
75
+ activeWeekDays: number[];
76
+ priority: number;
77
+ topic: string;
78
+ routedAt: string;
79
+ locale: string;
80
+ tags?: RoomTagResponse[];
81
+ members?: RoomMemberResponse[];
82
+ new?: boolean;
83
+ unreadMessagesCount?: number;
84
+ }
85
+ /** Live room entry for a user, including membership metadata and the nested room. */
86
+ interface LiveUserRoomResponse {
87
+ id: number;
88
+ recipientId: string;
89
+ unreadMessagesCount: string | number;
90
+ exited: boolean;
91
+ new: boolean;
92
+ provider: string;
93
+ channel: string;
94
+ room: RoomResponse;
95
+ }
96
+
97
+ export type { GetRoomByIdRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse };
@@ -0,0 +1,97 @@
1
+ /** Query parameters for listing live rooms assigned to a user. */
2
+ interface ListLiveUserRoomsRequest {
3
+ recipientId: string;
4
+ companyId: string;
5
+ isOpen: boolean;
6
+ }
7
+ /** Query parameters for fetching a room by its identifier. */
8
+ interface GetRoomByIdRequest {
9
+ companyId?: string;
10
+ includeMembers?: boolean;
11
+ }
12
+ /** Date range used to determine room activity windows. */
13
+ interface RoomActiveDates {
14
+ gte: string;
15
+ lte: string;
16
+ }
17
+ /** Tag associated with a chat room. */
18
+ interface RoomTagResponse {
19
+ id: string;
20
+ chatRoomId: number;
21
+ tagId: number;
22
+ tagName: string;
23
+ companyId: string;
24
+ createdAt: string;
25
+ updatedAt: string;
26
+ }
27
+ /** Member participating in a chat room. */
28
+ interface RoomMemberResponse {
29
+ id: number;
30
+ exited: boolean;
31
+ new: boolean;
32
+ recipientId: string;
33
+ subject?: string;
34
+ origin: string;
35
+ chatRoomId: number;
36
+ externalClientId?: string;
37
+ provider: string;
38
+ providerAccessToken?: string;
39
+ channel: string;
40
+ companyId: string;
41
+ createdAt: string;
42
+ updatedAt: string;
43
+ }
44
+ /** Chat room entity returned by the Chat Webservice API. */
45
+ interface RoomResponse {
46
+ id: number;
47
+ subject: string;
48
+ companyId: string;
49
+ chatConfigId: string;
50
+ status: string;
51
+ open: boolean;
52
+ inTransfer: boolean;
53
+ closedBy: string;
54
+ latestTransferId: string;
55
+ waitTime: number;
56
+ attendanceTime: number;
57
+ score: number;
58
+ csatFeedback?: string | null;
59
+ currentRule: string;
60
+ queueId: string;
61
+ campaignId?: string;
62
+ createdBy: string;
63
+ creatorProvider: string;
64
+ lastClientMsgAt: string;
65
+ lastOperatorMsgAt: string;
66
+ createdAt: string;
67
+ updatedAt: string;
68
+ inactivityLimit: number;
69
+ wasTransferred: boolean;
70
+ wasFinishedSilently: boolean;
71
+ type: string;
72
+ answeredAt: string;
73
+ protocol: string;
74
+ activeDates: RoomActiveDates;
75
+ activeWeekDays: number[];
76
+ priority: number;
77
+ topic: string;
78
+ routedAt: string;
79
+ locale: string;
80
+ tags?: RoomTagResponse[];
81
+ members?: RoomMemberResponse[];
82
+ new?: boolean;
83
+ unreadMessagesCount?: number;
84
+ }
85
+ /** Live room entry for a user, including membership metadata and the nested room. */
86
+ interface LiveUserRoomResponse {
87
+ id: number;
88
+ recipientId: string;
89
+ unreadMessagesCount: string | number;
90
+ exited: boolean;
91
+ new: boolean;
92
+ provider: string;
93
+ channel: string;
94
+ room: RoomResponse;
95
+ }
96
+
97
+ export type { GetRoomByIdRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse };
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __copyProps = (to, from, except, desc) => {
7
+ if (from && typeof from === "object" || typeof from === "function") {
8
+ for (let key of __getOwnPropNames(from))
9
+ if (!__hasOwnProp.call(to, key) && key !== except)
10
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
11
+ }
12
+ return to;
13
+ };
14
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
15
+
16
+ // src/chat-webservice/contracts/index.ts
17
+ var contracts_exports = {};
18
+ module.exports = __toCommonJS(contracts_exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../src/chat-webservice/contracts/index.ts"],"sourcesContent":["export * from './room';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
@@ -0,0 +1 @@
1
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}