@wildix/xbees-conversations-client 4.2.1 → 4.2.3

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.
@@ -561,25 +561,6 @@ declare const DescribeEventCommand_base: {
561
561
  * // },
562
562
  * // },
563
563
  * // ],
564
- * // wilma: { // WilmaChatElement
565
- * // sessionId: "STRING_VALUE", // required
566
- * // verbosity: "none" || "simple" || "full", // required
567
- * // inspect: { // WilmaChatInspect
568
- * // outcome: "done" || "stopped" || "failed", // required
569
- * // durationMs: Number("int"),
570
- * // toolCount: Number("int"), // required
571
- * // failedCount: Number("int"), // required
572
- * // },
573
- * // artifacts: [ // WilmaChatArtifactCardList
574
- * // { // WilmaChatArtifactCard
575
- * // artifactId: "STRING_VALUE", // required
576
- * // title: "STRING_VALUE", // required
577
- * // kind: "STRING_VALUE", // required
578
- * // size: Number("long"), // required
579
- * // name: "STRING_VALUE",
580
- * // },
581
- * // ],
582
- * // },
583
564
  * // },
584
565
  * // ],
585
566
  * // attachments: [ // MessageAttachmentList
@@ -722,25 +703,6 @@ declare const DescribeEventCommand_base: {
722
703
  * // },
723
704
  * // },
724
705
  * // ],
725
- * // wilma: {
726
- * // sessionId: "STRING_VALUE", // required
727
- * // verbosity: "none" || "simple" || "full", // required
728
- * // inspect: {
729
- * // outcome: "done" || "stopped" || "failed", // required
730
- * // durationMs: Number("int"),
731
- * // toolCount: Number("int"), // required
732
- * // failedCount: Number("int"), // required
733
- * // },
734
- * // artifacts: [
735
- * // {
736
- * // artifactId: "STRING_VALUE", // required
737
- * // title: "STRING_VALUE", // required
738
- * // kind: "STRING_VALUE", // required
739
- * // size: Number("long"), // required
740
- * // name: "STRING_VALUE",
741
- * // },
742
- * // ],
743
- * // },
744
706
  * // },
745
707
  * // ],
746
708
  * // attachments: [
@@ -881,25 +843,6 @@ declare const DescribeEventCommand_base: {
881
843
  * // },
882
844
  * // },
883
845
  * // ],
884
- * // wilma: {
885
- * // sessionId: "STRING_VALUE", // required
886
- * // verbosity: "none" || "simple" || "full", // required
887
- * // inspect: {
888
- * // outcome: "done" || "stopped" || "failed", // required
889
- * // durationMs: Number("int"),
890
- * // toolCount: Number("int"), // required
891
- * // failedCount: Number("int"), // required
892
- * // },
893
- * // artifacts: [
894
- * // {
895
- * // artifactId: "STRING_VALUE", // required
896
- * // title: "STRING_VALUE", // required
897
- * // kind: "STRING_VALUE", // required
898
- * // size: Number("long"), // required
899
- * // name: "STRING_VALUE",
900
- * // },
901
- * // ],
902
- * // },
903
846
  * // },
904
847
  * // ],
905
848
  * // attachments: [
@@ -1016,25 +959,6 @@ declare const DescribeEventCommand_base: {
1016
959
  * // },
1017
960
  * // },
1018
961
  * // ],
1019
- * // wilma: {
1020
- * // sessionId: "STRING_VALUE", // required
1021
- * // verbosity: "none" || "simple" || "full", // required
1022
- * // inspect: {
1023
- * // outcome: "done" || "stopped" || "failed", // required
1024
- * // durationMs: Number("int"),
1025
- * // toolCount: Number("int"), // required
1026
- * // failedCount: Number("int"), // required
1027
- * // },
1028
- * // artifacts: [
1029
- * // {
1030
- * // artifactId: "STRING_VALUE", // required
1031
- * // title: "STRING_VALUE", // required
1032
- * // kind: "STRING_VALUE", // required
1033
- * // size: Number("long"), // required
1034
- * // name: "STRING_VALUE",
1035
- * // },
1036
- * // ],
1037
- * // },
1038
962
  * // },
1039
963
  * // ],
1040
964
  * // attachments: "<MessageAttachmentList>",
@@ -1133,25 +1057,6 @@ declare const DescribeEventCommand_base: {
1133
1057
  * // },
1134
1058
  * // },
1135
1059
  * // ],
1136
- * // wilma: {
1137
- * // sessionId: "STRING_VALUE", // required
1138
- * // verbosity: "none" || "simple" || "full", // required
1139
- * // inspect: {
1140
- * // outcome: "done" || "stopped" || "failed", // required
1141
- * // durationMs: Number("int"),
1142
- * // toolCount: Number("int"), // required
1143
- * // failedCount: Number("int"), // required
1144
- * // },
1145
- * // artifacts: [
1146
- * // {
1147
- * // artifactId: "STRING_VALUE", // required
1148
- * // title: "STRING_VALUE", // required
1149
- * // kind: "STRING_VALUE", // required
1150
- * // size: Number("long"), // required
1151
- * // name: "STRING_VALUE",
1152
- * // },
1153
- * // ],
1154
- * // },
1155
1060
  * // },
1156
1061
  * // ],
1157
1062
  * // attachments: "<MessageAttachmentList>",
@@ -78,25 +78,6 @@ declare const GetMessageCommand_base: {
78
78
  * // },
79
79
  * // },
80
80
  * // ],
81
- * // wilma: { // WilmaChatElement
82
- * // sessionId: "STRING_VALUE", // required
83
- * // verbosity: "none" || "simple" || "full", // required
84
- * // inspect: { // WilmaChatInspect
85
- * // outcome: "done" || "stopped" || "failed", // required
86
- * // durationMs: Number("int"),
87
- * // toolCount: Number("int"), // required
88
- * // failedCount: Number("int"), // required
89
- * // },
90
- * // artifacts: [ // WilmaChatArtifactCardList
91
- * // { // WilmaChatArtifactCard
92
- * // artifactId: "STRING_VALUE", // required
93
- * // title: "STRING_VALUE", // required
94
- * // kind: "STRING_VALUE", // required
95
- * // size: Number("long"), // required
96
- * // name: "STRING_VALUE",
97
- * // },
98
- * // ],
99
- * // },
100
81
  * // },
101
82
  * // ],
102
83
  * // attachments: [ // MessageAttachmentList
@@ -54,25 +54,15 @@ declare const InviteCommand_base: {
54
54
  * const command = new InviteCommand(input);
55
55
  * const response = await client.send(command);
56
56
  * // { // InviteOutput
57
- * // users: [ // UsersList // required
58
- * // { // User
57
+ * // users: [ // InvitedUsersList // required
58
+ * // { // InvitedUser
59
59
  * // id: "STRING_VALUE", // required
60
60
  * // name: "STRING_VALUE",
61
61
  * // email: "STRING_VALUE",
62
62
  * // phone: "STRING_VALUE",
63
- * // picture: "STRING_VALUE",
64
- * // locale: "STRING_VALUE",
65
- * // timeZone: "STRING_VALUE",
66
63
  * // company: "STRING_VALUE",
67
- * // bot: true || false,
68
- * // pbxDomain: "STRING_VALUE",
69
- * // pbxPort: "STRING_VALUE",
70
- * // pbxExtension: "STRING_VALUE",
71
- * // pbxSerial: "STRING_VALUE",
72
64
  * // pbxUserId: "STRING_VALUE",
73
- * // pbxGroupId: "STRING_VALUE",
74
- * // createdAt: "STRING_VALUE",
75
- * // updatedAt: "STRING_VALUE",
65
+ * // locale: "STRING_VALUE",
76
66
  * // },
77
67
  * // ],
78
68
  * // skippedInvitees: [ // SkippedMembersList // required
@@ -80,25 +80,6 @@ declare const ListMessagesCommand_base: {
80
80
  * // },
81
81
  * // },
82
82
  * // ],
83
- * // wilma: { // WilmaChatElement
84
- * // sessionId: "STRING_VALUE", // required
85
- * // verbosity: "none" || "simple" || "full", // required
86
- * // inspect: { // WilmaChatInspect
87
- * // outcome: "done" || "stopped" || "failed", // required
88
- * // durationMs: Number("int"),
89
- * // toolCount: Number("int"), // required
90
- * // failedCount: Number("int"), // required
91
- * // },
92
- * // artifacts: [ // WilmaChatArtifactCardList
93
- * // { // WilmaChatArtifactCard
94
- * // artifactId: "STRING_VALUE", // required
95
- * // title: "STRING_VALUE", // required
96
- * // kind: "STRING_VALUE", // required
97
- * // size: Number("long"), // required
98
- * // name: "STRING_VALUE",
99
- * // },
100
- * // ],
101
- * // },
102
83
  * // },
103
84
  * // ],
104
85
  * // attachments: [ // MessageAttachmentList
@@ -80,25 +80,6 @@ declare const ListPinnedMessagesCommand_base: {
80
80
  * // },
81
81
  * // },
82
82
  * // ],
83
- * // wilma: { // WilmaChatElement
84
- * // sessionId: "STRING_VALUE", // required
85
- * // verbosity: "none" || "simple" || "full", // required
86
- * // inspect: { // WilmaChatInspect
87
- * // outcome: "done" || "stopped" || "failed", // required
88
- * // durationMs: Number("int"),
89
- * // toolCount: Number("int"), // required
90
- * // failedCount: Number("int"), // required
91
- * // },
92
- * // artifacts: [ // WilmaChatArtifactCardList
93
- * // { // WilmaChatArtifactCard
94
- * // artifactId: "STRING_VALUE", // required
95
- * // title: "STRING_VALUE", // required
96
- * // kind: "STRING_VALUE", // required
97
- * // size: Number("long"), // required
98
- * // name: "STRING_VALUE",
99
- * // },
100
- * // ],
101
- * // },
102
83
  * // },
103
84
  * // ],
104
85
  * // attachments: [ // MessageAttachmentList
@@ -75,25 +75,6 @@ declare const PartialUpdateMessageCommand_base: {
75
75
  * },
76
76
  * },
77
77
  * ],
78
- * wilma: { // WilmaChatElement
79
- * sessionId: "STRING_VALUE", // required
80
- * verbosity: "none" || "simple" || "full", // required
81
- * inspect: { // WilmaChatInspect
82
- * outcome: "done" || "stopped" || "failed", // required
83
- * durationMs: Number("int"),
84
- * toolCount: Number("int"), // required
85
- * failedCount: Number("int"), // required
86
- * },
87
- * artifacts: [ // WilmaChatArtifactCardList
88
- * { // WilmaChatArtifactCard
89
- * artifactId: "STRING_VALUE", // required
90
- * title: "STRING_VALUE", // required
91
- * kind: "STRING_VALUE", // required
92
- * size: Number("long"), // required
93
- * name: "STRING_VALUE",
94
- * },
95
- * ],
96
- * },
97
78
  * },
98
79
  * ],
99
80
  * attachments: [ // MessageAttachmentList
@@ -244,25 +225,6 @@ declare const PartialUpdateMessageCommand_base: {
244
225
  * // },
245
226
  * // },
246
227
  * // ],
247
- * // wilma: { // WilmaChatElement
248
- * // sessionId: "STRING_VALUE", // required
249
- * // verbosity: "none" || "simple" || "full", // required
250
- * // inspect: { // WilmaChatInspect
251
- * // outcome: "done" || "stopped" || "failed", // required
252
- * // durationMs: Number("int"),
253
- * // toolCount: Number("int"), // required
254
- * // failedCount: Number("int"), // required
255
- * // },
256
- * // artifacts: [ // WilmaChatArtifactCardList
257
- * // { // WilmaChatArtifactCard
258
- * // artifactId: "STRING_VALUE", // required
259
- * // title: "STRING_VALUE", // required
260
- * // kind: "STRING_VALUE", // required
261
- * // size: Number("long"), // required
262
- * // name: "STRING_VALUE",
263
- * // },
264
- * // ],
265
- * // },
266
228
  * // },
267
229
  * // ],
268
230
  * // attachments: [ // MessageAttachmentList
@@ -86,25 +86,6 @@ declare const SendGiphyCommand_base: {
86
86
  * // },
87
87
  * // },
88
88
  * // ],
89
- * // wilma: { // WilmaChatElement
90
- * // sessionId: "STRING_VALUE", // required
91
- * // verbosity: "none" || "simple" || "full", // required
92
- * // inspect: { // WilmaChatInspect
93
- * // outcome: "done" || "stopped" || "failed", // required
94
- * // durationMs: Number("int"),
95
- * // toolCount: Number("int"), // required
96
- * // failedCount: Number("int"), // required
97
- * // },
98
- * // artifacts: [ // WilmaChatArtifactCardList
99
- * // { // WilmaChatArtifactCard
100
- * // artifactId: "STRING_VALUE", // required
101
- * // title: "STRING_VALUE", // required
102
- * // kind: "STRING_VALUE", // required
103
- * // size: Number("long"), // required
104
- * // name: "STRING_VALUE",
105
- * // },
106
- * // ],
107
- * // },
108
89
  * // },
109
90
  * // ],
110
91
  * // attachments: [ // MessageAttachmentList
@@ -71,25 +71,6 @@ declare const SendMessageCommand_base: {
71
71
  * },
72
72
  * },
73
73
  * ],
74
- * wilma: { // WilmaChatElement
75
- * sessionId: "STRING_VALUE", // required
76
- * verbosity: "none" || "simple" || "full", // required
77
- * inspect: { // WilmaChatInspect
78
- * outcome: "done" || "stopped" || "failed", // required
79
- * durationMs: Number("int"),
80
- * toolCount: Number("int"), // required
81
- * failedCount: Number("int"), // required
82
- * },
83
- * artifacts: [ // WilmaChatArtifactCardList
84
- * { // WilmaChatArtifactCard
85
- * artifactId: "STRING_VALUE", // required
86
- * title: "STRING_VALUE", // required
87
- * kind: "STRING_VALUE", // required
88
- * size: Number("long"), // required
89
- * name: "STRING_VALUE",
90
- * },
91
- * ],
92
- * },
93
74
  * },
94
75
  * ],
95
76
  * attachments: [ // MessageAttachmentList
@@ -238,25 +219,6 @@ declare const SendMessageCommand_base: {
238
219
  * // },
239
220
  * // },
240
221
  * // ],
241
- * // wilma: { // WilmaChatElement
242
- * // sessionId: "STRING_VALUE", // required
243
- * // verbosity: "none" || "simple" || "full", // required
244
- * // inspect: { // WilmaChatInspect
245
- * // outcome: "done" || "stopped" || "failed", // required
246
- * // durationMs: Number("int"),
247
- * // toolCount: Number("int"), // required
248
- * // failedCount: Number("int"), // required
249
- * // },
250
- * // artifacts: [ // WilmaChatArtifactCardList
251
- * // { // WilmaChatArtifactCard
252
- * // artifactId: "STRING_VALUE", // required
253
- * // title: "STRING_VALUE", // required
254
- * // kind: "STRING_VALUE", // required
255
- * // size: Number("long"), // required
256
- * // name: "STRING_VALUE",
257
- * // },
258
- * // ],
259
- * // },
260
222
  * // },
261
223
  * // ],
262
224
  * // attachments: [ // MessageAttachmentList
@@ -86,25 +86,6 @@ declare const SendSystemMessageCommand_base: {
86
86
  * // },
87
87
  * // },
88
88
  * // ],
89
- * // wilma: { // WilmaChatElement
90
- * // sessionId: "STRING_VALUE", // required
91
- * // verbosity: "none" || "simple" || "full", // required
92
- * // inspect: { // WilmaChatInspect
93
- * // outcome: "done" || "stopped" || "failed", // required
94
- * // durationMs: Number("int"),
95
- * // toolCount: Number("int"), // required
96
- * // failedCount: Number("int"), // required
97
- * // },
98
- * // artifacts: [ // WilmaChatArtifactCardList
99
- * // { // WilmaChatArtifactCard
100
- * // artifactId: "STRING_VALUE", // required
101
- * // title: "STRING_VALUE", // required
102
- * // kind: "STRING_VALUE", // required
103
- * // size: Number("long"), // required
104
- * // name: "STRING_VALUE",
105
- * // },
106
- * // ],
107
- * // },
108
89
  * // },
109
90
  * // ],
110
91
  * // attachments: [ // MessageAttachmentList
@@ -71,25 +71,6 @@ declare const UpdateMessageCommand_base: {
71
71
  * },
72
72
  * },
73
73
  * ],
74
- * wilma: { // WilmaChatElement
75
- * sessionId: "STRING_VALUE", // required
76
- * verbosity: "none" || "simple" || "full", // required
77
- * inspect: { // WilmaChatInspect
78
- * outcome: "done" || "stopped" || "failed", // required
79
- * durationMs: Number("int"),
80
- * toolCount: Number("int"), // required
81
- * failedCount: Number("int"), // required
82
- * },
83
- * artifacts: [ // WilmaChatArtifactCardList
84
- * { // WilmaChatArtifactCard
85
- * artifactId: "STRING_VALUE", // required
86
- * title: "STRING_VALUE", // required
87
- * kind: "STRING_VALUE", // required
88
- * size: Number("long"), // required
89
- * name: "STRING_VALUE",
90
- * },
91
- * ],
92
- * },
93
74
  * },
94
75
  * ],
95
76
  * attachments: [ // MessageAttachmentList
@@ -239,25 +220,6 @@ declare const UpdateMessageCommand_base: {
239
220
  * // },
240
221
  * // },
241
222
  * // ],
242
- * // wilma: { // WilmaChatElement
243
- * // sessionId: "STRING_VALUE", // required
244
- * // verbosity: "none" || "simple" || "full", // required
245
- * // inspect: { // WilmaChatInspect
246
- * // outcome: "done" || "stopped" || "failed", // required
247
- * // durationMs: Number("int"),
248
- * // toolCount: Number("int"), // required
249
- * // failedCount: Number("int"), // required
250
- * // },
251
- * // artifacts: [ // WilmaChatArtifactCardList
252
- * // { // WilmaChatArtifactCard
253
- * // artifactId: "STRING_VALUE", // required
254
- * // title: "STRING_VALUE", // required
255
- * // kind: "STRING_VALUE", // required
256
- * // size: Number("long"), // required
257
- * // name: "STRING_VALUE",
258
- * // },
259
- * // ],
260
- * // },
261
223
  * // },
262
224
  * // ],
263
225
  * // attachments: [ // MessageAttachmentList
@@ -105,32 +105,6 @@ export declare const ButtonVariant: {
105
105
  * @public
106
106
  */
107
107
  export type ButtonVariant = (typeof ButtonVariant)[keyof typeof ButtonVariant];
108
- /**
109
- * @public
110
- * @enum
111
- */
112
- export declare const WilmaChatInspectOutcome: {
113
- readonly DONE: "done";
114
- readonly FAILED: "failed";
115
- readonly STOPPED: "stopped";
116
- };
117
- /**
118
- * @public
119
- */
120
- export type WilmaChatInspectOutcome = (typeof WilmaChatInspectOutcome)[keyof typeof WilmaChatInspectOutcome];
121
- /**
122
- * @public
123
- * @enum
124
- */
125
- export declare const WilmaChatVerbosity: {
126
- readonly FULL: "full";
127
- readonly NONE: "none";
128
- readonly SIMPLE: "simple";
129
- };
130
- /**
131
- * @public
132
- */
133
- export type WilmaChatVerbosity = (typeof WilmaChatVerbosity)[keyof typeof WilmaChatVerbosity];
134
108
  /**
135
109
  * @public
136
110
  * @enum
@@ -1,4 +1,4 @@
1
- import type { ActionTriggerStatus, AssignChannelVariant, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessagingStatus, ChannelType, ChannelWhatsAppStatus, ConversationFileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MessageMessagingStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, MessagingChannel, ReactionType, WebhookEventType, WilmaChatInspectOutcome, WilmaChatVerbosity } from "./enums";
1
+ import type { ActionTriggerStatus, AssignChannelVariant, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessagingStatus, ChannelType, ChannelWhatsAppStatus, ConversationFileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MessageMessagingStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, MessagingChannel, ReactionType, WebhookEventType } from "./enums";
2
2
  /**
3
3
  * @public
4
4
  */
@@ -264,44 +264,9 @@ export interface MessageTemplateConfig {
264
264
  whatsapp?: TemplateWithParameters | undefined;
265
265
  }
266
266
  /**
267
- * Artifact card under a Wilma chat bubble. File bytes stay in the artifacts store; open uses artifactId.
268
267
  * @public
269
268
  */
270
- export interface WilmaChatArtifactCard {
271
- artifactId: string;
272
- title: string;
273
- kind: string;
274
- size: number;
275
- name?: string | undefined;
276
- }
277
- /**
278
- * Inspect caption under a Wilma chat bubble. Tool input and output are not stored here; the client loads them with GetSessionEvents using sessionId.
279
- * @public
280
- */
281
- export interface WilmaChatInspect {
282
- outcome: WilmaChatInspectOutcome;
283
- durationMs?: number | undefined;
284
- toolCount: number;
285
- failedCount: number;
286
- }
287
- /**
288
- * Snapshot painted under a Wilma chat agent message: inspect caption and artifact cards, plus ids to open details. Not reply buttons.
289
- * @public
290
- */
291
- export interface WilmaChatElement {
292
- sessionId: string;
293
- verbosity: WilmaChatVerbosity;
294
- /**
295
- * Inspect caption under a Wilma chat bubble. Tool input and output are not stored here; the client loads them with GetSessionEvents using sessionId.
296
- * @public
297
- */
298
- inspect?: WilmaChatInspect | undefined;
299
- artifacts?: WilmaChatArtifactCard[] | undefined;
300
- }
301
- /**
302
- * @public
303
- */
304
- export type Element = Element.ActionsMember | Element.TemplateMember | Element.WilmaMember | Element.$UnknownMember;
269
+ export type Element = Element.ActionsMember | Element.TemplateMember | Element.$UnknownMember;
305
270
  /**
306
271
  * @public
307
272
  */
@@ -309,23 +274,11 @@ export declare namespace Element {
309
274
  interface TemplateMember {
310
275
  template: MessageTemplateConfig;
311
276
  actions?: never;
312
- wilma?: never;
313
277
  $unknown?: never;
314
278
  }
315
279
  interface ActionsMember {
316
280
  template?: never;
317
281
  actions: ActionElement[];
318
- wilma?: never;
319
- $unknown?: never;
320
- }
321
- /**
322
- * Snapshot painted under a Wilma chat agent message: inspect caption and artifact cards, plus ids to open details. Not reply buttons.
323
- * @public
324
- */
325
- interface WilmaMember {
326
- template?: never;
327
- actions?: never;
328
- wilma: WilmaChatElement;
329
282
  $unknown?: never;
330
283
  }
331
284
  /**
@@ -334,7 +287,6 @@ export declare namespace Element {
334
287
  interface $UnknownMember {
335
288
  template?: never;
336
289
  actions?: never;
337
- wilma?: never;
338
290
  $unknown: [string, any];
339
291
  }
340
292
  /**
@@ -344,7 +296,6 @@ export declare namespace Element {
344
296
  interface Visitor<T> {
345
297
  template: (value: MessageTemplateConfig) => T;
346
298
  actions: (value: ActionElement[]) => T;
347
- wilma: (value: WilmaChatElement) => T;
348
299
  _: (name: string, value: any) => T;
349
300
  }
350
301
  }
@@ -1978,15 +1929,42 @@ export interface InviteInput {
1978
1929
  */
1979
1930
  invitees: UserToInvite[];
1980
1931
  }
1932
+ /**
1933
+ * Reduced user record returned by Invite. Callers receive only the fields they use to correlate the invitee and continue the conversation flow: id, name, email, phone, company, pbxUserId, and locale.
1934
+ * PBX installation details (domain, port, extension, serial, group), profile metadata (picture, time zone, bot), and timestamps are not included.
1935
+ *
1936
+ * @public
1937
+ */
1938
+ export interface InvitedUser {
1939
+ id: string;
1940
+ name?: string | undefined;
1941
+ email?: string | undefined;
1942
+ phone?: string | undefined;
1943
+ /**
1944
+ * Tenant id. Callers use it to tell a colleague from an external user.
1945
+ * @public
1946
+ */
1947
+ company?: string | undefined;
1948
+ /**
1949
+ * PBX user id of a colleague. A caller that already knows the colleague matches the invite result by this value.
1950
+ * @public
1951
+ */
1952
+ pbxUserId?: string | undefined;
1953
+ /**
1954
+ * Preferred user language. Notification emails sent to the invitee use it to pick the template language.
1955
+ * @public
1956
+ */
1957
+ locale?: string | undefined;
1958
+ }
1981
1959
  /**
1982
1960
  * @public
1983
1961
  */
1984
1962
  export interface InviteOutput {
1985
1963
  /**
1986
- * A list of users who were successfully invited.
1964
+ * A list of users who were successfully invited. Each entry contains only id, name, email, phone, company, pbxUserId, and locale.
1987
1965
  * @public
1988
1966
  */
1989
- users: User[];
1967
+ users: InvitedUser[];
1990
1968
  /**
1991
1969
  * A list of invitees that were skipped during the operation, for example because the resolved account is deactivated in GetStream. Each entry carries the email or phone supplied in the request, and the user id when it was already known.
1992
1970
  * @public
@@ -110,6 +110,7 @@ export declare var InboxTag$: StaticStructureSchema;
110
110
  export declare var InboxTaggedChannel$: StaticStructureSchema;
111
111
  export declare var InboxUnreadChannel$: StaticStructureSchema;
112
112
  export declare var InitialMessage$: StaticStructureSchema;
113
+ export declare var InvitedUser$: StaticStructureSchema;
113
114
  export declare var InviteInput$: StaticStructureSchema;
114
115
  export declare var InviteOutput$: StaticStructureSchema;
115
116
  export declare var JoinChannelInput$: StaticStructureSchema;
@@ -214,9 +215,6 @@ export declare var WebhookChatReactionNewEvent$: StaticStructureSchema;
214
215
  export declare var WebhookChatReactionNewOrDeletedEventData$: StaticStructureSchema;
215
216
  export declare var WelcomeMessage$: StaticStructureSchema;
216
217
  export declare var WhatsAppClosedSystemMessage$: StaticStructureSchema;
217
- export declare var WilmaChatArtifactCard$: StaticStructureSchema;
218
- export declare var WilmaChatElement$: StaticStructureSchema;
219
- export declare var WilmaChatInspect$: StaticStructureSchema;
220
218
  export declare var Service$: StaticStructureSchema;
221
219
  export declare var ServicePbx$: StaticStructureSchema;
222
220
  export declare var ServiceSettings$: StaticStructureSchema;
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": "4.2.1",
4
+ "version": "4.2.3",
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",