@wildix/xbees-conversations-client 1.1.24 → 1.1.27

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.
@@ -342,14 +342,18 @@ class MarkUnreadChannelsLimitReachedException extends ConversationsServiceExcept
342
342
  exports.MarkUnreadChannelsLimitReachedException = MarkUnreadChannelsLimitReachedException;
343
343
  exports.GroupChannelUnsetOptions = {
344
344
  ACCESS: "access",
345
+ ASSIGNEE: "assignee",
345
346
  BROADCAST: "broadcast",
346
347
  CONTEXT: "context",
347
348
  CONTEXT_EVENTS: "contextEvents",
348
349
  CONTEXT_PTT: "contextPtt",
349
350
  DESCRIPTION: "description",
351
+ KITE_ASSIGN: "kiteAssign",
350
352
  MMS: "mms",
351
353
  PICTURE: "picture",
352
354
  PICTURE_COLOR: "pictureColor",
355
+ SERVICE: "service",
356
+ SERVICE_TITLE: "serviceTitle",
353
357
  SMS: "sms",
354
358
  SUBJECT: "subject",
355
359
  WHATSAPP: "whatsapp",
@@ -398,6 +402,8 @@ var SystemMessage;
398
402
  SystemMessage.visit = (value, visitor) => {
399
403
  if (value.whatsAppClosed !== undefined)
400
404
  return visitor.whatsAppClosed(value.whatsAppClosed);
405
+ if (value.multipleMembersJoined !== undefined)
406
+ return visitor.multipleMembersJoined(value.multipleMembersJoined);
401
407
  return visitor._(value.$unknown[0], value.$unknown[1]);
402
408
  };
403
409
  })(SystemMessage || (exports.SystemMessage = SystemMessage = {}));
@@ -48,6 +48,7 @@ const se_AddChannelMembersCommand = async (input, context) => {
48
48
  'members': _ => (0, smithy_client_1._json)(_),
49
49
  'membersToInvite': _ => (0, smithy_client_1._json)(_),
50
50
  'silent': [],
51
+ 'unreadMessageId': [],
51
52
  }));
52
53
  b.m("PUT")
53
54
  .h(headers)
@@ -92,16 +93,19 @@ const se_CreateGroupChannelCommand = async (input, context) => {
92
93
  let body;
93
94
  body = JSON.stringify((0, smithy_client_1.take)(input, {
94
95
  'access': [],
96
+ 'assignee': _ => (0, smithy_client_1._json)(_),
95
97
  'autoRecord': [],
96
98
  'broadcast': [],
97
99
  'channelId': [],
98
100
  'context': _ => (0, smithy_client_1._json)(_),
99
101
  'description': [],
102
+ 'kiteAssign': [],
100
103
  'members': _ => (0, smithy_client_1._json)(_),
101
104
  'membersToInvite': _ => (0, smithy_client_1._json)(_),
102
105
  'mms': [],
103
106
  'picture': [],
104
107
  'pictureColor': [],
108
+ 'serviceTitle': [],
105
109
  'sms': [],
106
110
  'subject': [],
107
111
  'transcriptionLanguage': [],
@@ -564,12 +568,16 @@ const se_InviteCommand = async (input, context) => {
564
568
  'content-type': 'application/json',
565
569
  };
566
570
  b.bp("/v2/conversations/invite");
571
+ const query = (0, smithy_client_1.map)({
572
+ [_co]: [, input[_cI]],
573
+ });
567
574
  let body;
568
575
  body = JSON.stringify((0, smithy_client_1.take)(input, {
569
576
  'invitees': _ => (0, smithy_client_1._json)(_),
570
577
  }));
571
578
  b.m("POST")
572
579
  .h(headers)
580
+ .q(query)
573
581
  .b(body);
574
582
  return b.build();
575
583
  };
@@ -1174,13 +1182,16 @@ const se_UpdateChannelCommand = async (input, context) => {
1174
1182
  let body;
1175
1183
  body = JSON.stringify((0, smithy_client_1.take)(input, {
1176
1184
  'access': [],
1185
+ 'assignee': _ => (0, smithy_client_1._json)(_),
1177
1186
  'autoRecord': [],
1178
1187
  'broadcast': [],
1179
1188
  'context': _ => (0, smithy_client_1._json)(_),
1180
1189
  'description': [],
1190
+ 'kiteAssign': [],
1181
1191
  'mms': [],
1182
1192
  'picture': [],
1183
1193
  'pictureColor': [],
1194
+ 'serviceTitle': [],
1184
1195
  'silent': [],
1185
1196
  'sms': [],
1186
1197
  'subject': [],
@@ -324,14 +324,18 @@ export class MarkUnreadChannelsLimitReachedException extends __BaseException {
324
324
  }
325
325
  export const GroupChannelUnsetOptions = {
326
326
  ACCESS: "access",
327
+ ASSIGNEE: "assignee",
327
328
  BROADCAST: "broadcast",
328
329
  CONTEXT: "context",
329
330
  CONTEXT_EVENTS: "contextEvents",
330
331
  CONTEXT_PTT: "contextPtt",
331
332
  DESCRIPTION: "description",
333
+ KITE_ASSIGN: "kiteAssign",
332
334
  MMS: "mms",
333
335
  PICTURE: "picture",
334
336
  PICTURE_COLOR: "pictureColor",
337
+ SERVICE: "service",
338
+ SERVICE_TITLE: "serviceTitle",
335
339
  SMS: "sms",
336
340
  SUBJECT: "subject",
337
341
  WHATSAPP: "whatsapp",
@@ -378,6 +382,8 @@ export var SystemMessage;
378
382
  SystemMessage.visit = (value, visitor) => {
379
383
  if (value.whatsAppClosed !== undefined)
380
384
  return visitor.whatsAppClosed(value.whatsAppClosed);
385
+ if (value.multipleMembersJoined !== undefined)
386
+ return visitor.multipleMembersJoined(value.multipleMembersJoined);
381
387
  return visitor._(value.$unknown[0], value.$unknown[1]);
382
388
  };
383
389
  })(SystemMessage || (SystemMessage = {}));
@@ -42,6 +42,7 @@ export const se_AddChannelMembersCommand = async (input, context) => {
42
42
  'members': _ => _json(_),
43
43
  'membersToInvite': _ => _json(_),
44
44
  'silent': [],
45
+ 'unreadMessageId': [],
45
46
  }));
46
47
  b.m("PUT")
47
48
  .h(headers)
@@ -84,16 +85,19 @@ export const se_CreateGroupChannelCommand = async (input, context) => {
84
85
  let body;
85
86
  body = JSON.stringify(take(input, {
86
87
  'access': [],
88
+ 'assignee': _ => _json(_),
87
89
  'autoRecord': [],
88
90
  'broadcast': [],
89
91
  'channelId': [],
90
92
  'context': _ => _json(_),
91
93
  'description': [],
94
+ 'kiteAssign': [],
92
95
  'members': _ => _json(_),
93
96
  'membersToInvite': _ => _json(_),
94
97
  'mms': [],
95
98
  'picture': [],
96
99
  'pictureColor': [],
100
+ 'serviceTitle': [],
97
101
  'sms': [],
98
102
  'subject': [],
99
103
  'transcriptionLanguage': [],
@@ -530,12 +534,16 @@ export const se_InviteCommand = async (input, context) => {
530
534
  'content-type': 'application/json',
531
535
  };
532
536
  b.bp("/v2/conversations/invite");
537
+ const query = map({
538
+ [_co]: [, input[_cI]],
539
+ });
533
540
  let body;
534
541
  body = JSON.stringify(take(input, {
535
542
  'invitees': _ => _json(_),
536
543
  }));
537
544
  b.m("POST")
538
545
  .h(headers)
546
+ .q(query)
539
547
  .b(body);
540
548
  return b.build();
541
549
  };
@@ -1108,13 +1116,16 @@ export const se_UpdateChannelCommand = async (input, context) => {
1108
1116
  let body;
1109
1117
  body = JSON.stringify(take(input, {
1110
1118
  'access': [],
1119
+ 'assignee': _ => _json(_),
1111
1120
  'autoRecord': [],
1112
1121
  'broadcast': [],
1113
1122
  'context': _ => _json(_),
1114
1123
  'description': [],
1124
+ 'kiteAssign': [],
1115
1125
  'mms': [],
1116
1126
  'picture': [],
1117
1127
  'pictureColor': [],
1128
+ 'serviceTitle': [],
1118
1129
  'silent': [],
1119
1130
  'sms': [],
1120
1131
  'subject': [],
@@ -50,6 +50,7 @@ declare const AddChannelMembersCommand_base: {
50
50
  * },
51
51
  * ],
52
52
  * hideHistory: true || false,
53
+ * unreadMessageId: "STRING_VALUE",
53
54
  * };
54
55
  * const command = new AddChannelMembersCommand(input);
55
56
  * const response = await client.send(command);
@@ -68,6 +68,26 @@ declare const CreateGroupChannelCommand_base: {
68
68
  * sms: true || false,
69
69
  * mms: true || false,
70
70
  * whatsapp: true || false,
71
+ * kiteAssign: "STRING_VALUE",
72
+ * serviceTitle: "STRING_VALUE",
73
+ * assignee: { // User
74
+ * id: "STRING_VALUE", // required
75
+ * name: "STRING_VALUE",
76
+ * email: "STRING_VALUE",
77
+ * phone: "STRING_VALUE",
78
+ * picture: "STRING_VALUE",
79
+ * locale: "STRING_VALUE",
80
+ * timeZone: "STRING_VALUE",
81
+ * company: "STRING_VALUE",
82
+ * bot: true || false,
83
+ * pbxDomain: "STRING_VALUE",
84
+ * pbxPort: "STRING_VALUE",
85
+ * pbxExtension: "STRING_VALUE",
86
+ * pbxSerial: "STRING_VALUE",
87
+ * pbxUserId: "STRING_VALUE",
88
+ * createdAt: "STRING_VALUE",
89
+ * updatedAt: "STRING_VALUE",
90
+ * },
71
91
  * autoRecord: true || false,
72
92
  * transcriptionLanguage: "STRING_VALUE",
73
93
  * userId: "STRING_VALUE",
@@ -35,6 +35,7 @@ declare const InviteCommand_base: {
35
35
  * // const { ConversationsClient, InviteCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
36
36
  * const client = new ConversationsClient(config);
37
37
  * const input = { // InviteInput
38
+ * companyId: "STRING_VALUE",
38
39
  * invitees: [ // UsersToInviteList // required
39
40
  * { // UserToInvite
40
41
  * email: "STRING_VALUE",
@@ -72,11 +72,31 @@ declare const PartialUpdateChannelCommand_base: {
72
72
  * sms: true || false,
73
73
  * mms: true || false,
74
74
  * whatsapp: true || false,
75
+ * kiteAssign: "STRING_VALUE",
76
+ * serviceTitle: "STRING_VALUE",
77
+ * assignee: { // User
78
+ * id: "STRING_VALUE", // required
79
+ * name: "STRING_VALUE",
80
+ * email: "STRING_VALUE",
81
+ * phone: "STRING_VALUE",
82
+ * picture: "STRING_VALUE",
83
+ * locale: "STRING_VALUE",
84
+ * timeZone: "STRING_VALUE",
85
+ * company: "STRING_VALUE",
86
+ * bot: true || false,
87
+ * pbxDomain: "STRING_VALUE",
88
+ * pbxPort: "STRING_VALUE",
89
+ * pbxExtension: "STRING_VALUE",
90
+ * pbxSerial: "STRING_VALUE",
91
+ * pbxUserId: "STRING_VALUE",
92
+ * createdAt: "STRING_VALUE",
93
+ * updatedAt: "STRING_VALUE",
94
+ * },
75
95
  * autoRecord: true || false,
76
96
  * transcriptionLanguage: "STRING_VALUE",
77
97
  * },
78
98
  * unset: [ // PartialUpdateChannelUnsetOptions
79
- * "subject" || "description" || "picture" || "pictureColor" || "access" || "broadcast" || "context" || "contextPtt" || "contextEvents" || "whatsappStatus" || "sms" || "mms" || "whatsapp",
99
+ * "subject" || "description" || "picture" || "pictureColor" || "access" || "broadcast" || "context" || "contextPtt" || "contextEvents" || "whatsappStatus" || "kiteAssign" || "service" || "serviceTitle" || "assignee" || "sms" || "mms" || "whatsapp",
80
100
  * ],
81
101
  * };
82
102
  * const command = new PartialUpdateChannelCommand(input);
@@ -39,6 +39,11 @@ declare const SendSystemMessageCommand_base: {
39
39
  * userId: "STRING_VALUE",
40
40
  * message: { // SystemMessage Union: only one key present
41
41
  * whatsAppClosed: {},
42
+ * multipleMembersJoined: { // MultipleMembersJoinedSystemMessage
43
+ * addedMembers: [ // UsersIdList // required
44
+ * "STRING_VALUE",
45
+ * ],
46
+ * },
42
47
  * },
43
48
  * };
44
49
  * const command = new SendSystemMessageCommand(input);
@@ -68,6 +68,26 @@ declare const UpdateChannelCommand_base: {
68
68
  * sms: true || false,
69
69
  * mms: true || false,
70
70
  * whatsapp: true || false,
71
+ * kiteAssign: "STRING_VALUE",
72
+ * serviceTitle: "STRING_VALUE",
73
+ * assignee: { // User
74
+ * id: "STRING_VALUE", // required
75
+ * name: "STRING_VALUE",
76
+ * email: "STRING_VALUE",
77
+ * phone: "STRING_VALUE",
78
+ * picture: "STRING_VALUE",
79
+ * locale: "STRING_VALUE",
80
+ * timeZone: "STRING_VALUE",
81
+ * company: "STRING_VALUE",
82
+ * bot: true || false,
83
+ * pbxDomain: "STRING_VALUE",
84
+ * pbxPort: "STRING_VALUE",
85
+ * pbxExtension: "STRING_VALUE",
86
+ * pbxSerial: "STRING_VALUE",
87
+ * pbxUserId: "STRING_VALUE",
88
+ * createdAt: "STRING_VALUE",
89
+ * updatedAt: "STRING_VALUE",
90
+ * },
71
91
  * autoRecord: true || false,
72
92
  * transcriptionLanguage: "STRING_VALUE",
73
93
  * channelId: "STRING_VALUE", // required
@@ -257,9 +257,28 @@ export type ActionTriggerStatus = typeof ActionTriggerStatus[keyof typeof Action
257
257
  * @public
258
258
  */
259
259
  export interface UserToInvite {
260
+ /**
261
+ * The email address of the invited user. If no user exists with the specified email and colleague flag is provided, the system will retrieve the colleague's details from the PBX.
262
+ * @public
263
+ */
260
264
  email?: string | undefined;
265
+ /**
266
+ * The phone number of the invited user. This phone number is used to create or find the user if an email address is not provided.
267
+ * @public
268
+ */
261
269
  phone?: string | undefined;
270
+ /**
271
+ * An optional name for the invited user. If the user logs in later and a different name is provided via SSO or the PBX, the system will update the user's name accordingly.
272
+ * @public
273
+ */
262
274
  name?: string | undefined;
275
+ /**
276
+ * A flag to indicate that specified email are registered colleague on the PBX.
277
+ * When provided, the system will search for the colleague on the PBX and automatically establish a connection to the organization if one does not already exist.
278
+ * If the specified colleague does not exist on the WMS, a ValidationException will be thrown and no users will be invited.
279
+ *
280
+ * @public
281
+ */
263
282
  colleague?: boolean | undefined;
264
283
  }
265
284
  /**
@@ -388,6 +407,11 @@ export interface AddChannelMembersInput {
388
407
  * @public
389
408
  */
390
409
  hideHistory?: boolean | undefined;
410
+ /**
411
+ * The unique identifier of the message that should be marked as unread for the added member.
412
+ * @public
413
+ */
414
+ unreadMessageId?: string | undefined;
391
415
  }
392
416
  /**
393
417
  * @public
@@ -786,6 +810,17 @@ export interface CreateGroupChannelInput {
786
810
  * @public
787
811
  */
788
812
  whatsapp?: boolean | undefined;
813
+ /**
814
+ * The unique identifier of the assignee.
815
+ * @public
816
+ */
817
+ kiteAssign?: string | undefined;
818
+ serviceTitle?: string | undefined;
819
+ /**
820
+ * A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
821
+ * @public
822
+ */
823
+ assignee?: User | undefined;
789
824
  autoRecord?: boolean | undefined;
790
825
  transcriptionLanguage?: string | undefined;
791
826
  /**
@@ -2021,6 +2056,11 @@ export interface HideChannelOutput {
2021
2056
  * @public
2022
2057
  */
2023
2058
  export interface InviteInput {
2059
+ /**
2060
+ * The unique identifier of the tenant when a service token is used.
2061
+ * @public
2062
+ */
2063
+ companyId?: string | undefined;
2024
2064
  /**
2025
2065
  * A list of users to invite. The list must contain between 1 and 20 users.
2026
2066
  * @public
@@ -2441,6 +2481,17 @@ export interface PartialUpdateChannelSetOptions {
2441
2481
  * @public
2442
2482
  */
2443
2483
  whatsapp?: boolean | undefined;
2484
+ /**
2485
+ * The unique identifier of the assignee.
2486
+ * @public
2487
+ */
2488
+ kiteAssign?: string | undefined;
2489
+ serviceTitle?: string | undefined;
2490
+ /**
2491
+ * A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
2492
+ * @public
2493
+ */
2494
+ assignee?: User | undefined;
2444
2495
  autoRecord?: boolean | undefined;
2445
2496
  transcriptionLanguage?: string | undefined;
2446
2497
  }
@@ -2450,14 +2501,18 @@ export interface PartialUpdateChannelSetOptions {
2450
2501
  */
2451
2502
  export declare const GroupChannelUnsetOptions: {
2452
2503
  readonly ACCESS: "access";
2504
+ readonly ASSIGNEE: "assignee";
2453
2505
  readonly BROADCAST: "broadcast";
2454
2506
  readonly CONTEXT: "context";
2455
2507
  readonly CONTEXT_EVENTS: "contextEvents";
2456
2508
  readonly CONTEXT_PTT: "contextPtt";
2457
2509
  readonly DESCRIPTION: "description";
2510
+ readonly KITE_ASSIGN: "kiteAssign";
2458
2511
  readonly MMS: "mms";
2459
2512
  readonly PICTURE: "picture";
2460
2513
  readonly PICTURE_COLOR: "pictureColor";
2514
+ readonly SERVICE: "service";
2515
+ readonly SERVICE_TITLE: "serviceTitle";
2461
2516
  readonly SMS: "sms";
2462
2517
  readonly SUBJECT: "subject";
2463
2518
  readonly WHATSAPP: "whatsapp";
@@ -2835,6 +2890,12 @@ export interface SendMessageReactionInput {
2835
2890
  */
2836
2891
  export interface SendMessageReactionOutput {
2837
2892
  }
2893
+ /**
2894
+ * @public
2895
+ */
2896
+ export interface MultipleMembersJoinedSystemMessage {
2897
+ addedMembers: (string)[];
2898
+ }
2838
2899
  /**
2839
2900
  * @public
2840
2901
  */
@@ -2843,7 +2904,7 @@ export interface WhatsAppClosedSystemMessage {
2843
2904
  /**
2844
2905
  * @public
2845
2906
  */
2846
- export type SystemMessage = SystemMessage.WhatsAppClosedMember | SystemMessage.$UnknownMember;
2907
+ export type SystemMessage = SystemMessage.MultipleMembersJoinedMember | SystemMessage.WhatsAppClosedMember | SystemMessage.$UnknownMember;
2847
2908
  /**
2848
2909
  * @public
2849
2910
  */
@@ -2854,6 +2915,16 @@ export declare namespace SystemMessage {
2854
2915
  */
2855
2916
  interface WhatsAppClosedMember {
2856
2917
  whatsAppClosed: WhatsAppClosedSystemMessage;
2918
+ multipleMembersJoined?: never;
2919
+ $unknown?: never;
2920
+ }
2921
+ /**
2922
+ * A message indicating that multiple members have joined the channel.
2923
+ * @public
2924
+ */
2925
+ interface MultipleMembersJoinedMember {
2926
+ whatsAppClosed?: never;
2927
+ multipleMembersJoined: MultipleMembersJoinedSystemMessage;
2857
2928
  $unknown?: never;
2858
2929
  }
2859
2930
  /**
@@ -2861,10 +2932,12 @@ export declare namespace SystemMessage {
2861
2932
  */
2862
2933
  interface $UnknownMember {
2863
2934
  whatsAppClosed?: never;
2935
+ multipleMembersJoined?: never;
2864
2936
  $unknown: [string, any];
2865
2937
  }
2866
2938
  interface Visitor<T> {
2867
2939
  whatsAppClosed: (value: WhatsAppClosedSystemMessage) => T;
2940
+ multipleMembersJoined: (value: MultipleMembersJoinedSystemMessage) => T;
2868
2941
  _: (name: string, value: any) => T;
2869
2942
  }
2870
2943
  const visit: <T>(value: SystemMessage, visitor: Visitor<T>) => T;
@@ -3164,6 +3237,17 @@ export interface UpdateChannelInput {
3164
3237
  * @public
3165
3238
  */
3166
3239
  whatsapp?: boolean | undefined;
3240
+ /**
3241
+ * The unique identifier of the assignee.
3242
+ * @public
3243
+ */
3244
+ kiteAssign?: string | undefined;
3245
+ serviceTitle?: string | undefined;
3246
+ /**
3247
+ * A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
3248
+ * @public
3249
+ */
3250
+ assignee?: User | undefined;
3167
3251
  autoRecord?: boolean | undefined;
3168
3252
  transcriptionLanguage?: string | undefined;
3169
3253
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wildix/xbees-conversations-client",
3
3
  "description": "@wildix/xbees-conversations-client client",
4
- "version": "1.1.24",
4
+ "version": "1.1.27",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",