@wildix/xbees-conversations-client 1.1.13 → 1.1.14

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.
Files changed (75) hide show
  1. package/dist-cjs/ConversationsClient.js +4 -5
  2. package/dist-cjs/models/models_0.js +48 -43
  3. package/dist-cjs/protocols/Aws_restJson1.js +101 -150
  4. package/dist-cjs/runtimeConfig.browser.js +1 -1
  5. package/dist-cjs/runtimeConfig.js +4 -3
  6. package/dist-cjs/runtimeExtensions.js +2 -10
  7. package/dist-es/ConversationsClient.js +4 -5
  8. package/dist-es/models/models_0.js +43 -38
  9. package/dist-es/protocols/Aws_restJson1.js +5 -54
  10. package/dist-es/runtimeConfig.browser.js +2 -2
  11. package/dist-es/runtimeConfig.js +5 -4
  12. package/dist-es/runtimeExtensions.js +2 -10
  13. package/dist-types/ConversationsClient.d.ts +1 -1
  14. package/dist-types/commands/AddChannelMemberCommand.d.ts +13 -0
  15. package/dist-types/commands/AddChannelMembersCommand.d.ts +13 -0
  16. package/dist-types/commands/AssignChannelCommand.d.ts +12 -0
  17. package/dist-types/commands/CreateGroupChannelCommand.d.ts +12 -0
  18. package/dist-types/commands/CreateInboxTagCommand.d.ts +12 -0
  19. package/dist-types/commands/CreateKiteChannelCommand.d.ts +12 -0
  20. package/dist-types/commands/DeleteChannelCommand.d.ts +12 -0
  21. package/dist-types/commands/DeleteChannelMemberCommand.d.ts +12 -0
  22. package/dist-types/commands/DeleteInboxTagCommand.d.ts +12 -0
  23. package/dist-types/commands/DeleteMessageCommand.d.ts +12 -0
  24. package/dist-types/commands/DeleteMessageReactionCommand.d.ts +12 -0
  25. package/dist-types/commands/DescribeEventCommand.d.ts +12 -0
  26. package/dist-types/commands/GetActionTriggerResultCommand.d.ts +12 -0
  27. package/dist-types/commands/GetChannelCommand.d.ts +12 -0
  28. package/dist-types/commands/GetChannelMemberCommand.d.ts +12 -0
  29. package/dist-types/commands/GetDirectChannelIdCommand.d.ts +12 -0
  30. package/dist-types/commands/GetFilePresignedDownloadUrlCommand.d.ts +12 -0
  31. package/dist-types/commands/GetInboxStateCommand.d.ts +12 -0
  32. package/dist-types/commands/GetMessageCommand.d.ts +12 -0
  33. package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts +12 -0
  34. package/dist-types/commands/GetTokenCommand.d.ts +12 -0
  35. package/dist-types/commands/GetUploadedFileInfoCommand.d.ts +12 -0
  36. package/dist-types/commands/HideChannelCommand.d.ts +12 -0
  37. package/dist-types/commands/InviteCommand.d.ts +12 -0
  38. package/dist-types/commands/JoinChannelCommand.d.ts +12 -0
  39. package/dist-types/commands/LeaveChannelCommand.d.ts +12 -0
  40. package/dist-types/commands/ListChannelMembersCommand.d.ts +12 -0
  41. package/dist-types/commands/ListChannelsCommand.d.ts +12 -0
  42. package/dist-types/commands/ListInboxTaggedChannelsCommand.d.ts +12 -0
  43. package/dist-types/commands/ListInboxTagsCommand.d.ts +12 -0
  44. package/dist-types/commands/ListMessageReactionsCommand.d.ts +12 -0
  45. package/dist-types/commands/ListMessagesCommand.d.ts +12 -0
  46. package/dist-types/commands/ListPinnedMessagesCommand.d.ts +12 -0
  47. package/dist-types/commands/MarkReadCommand.d.ts +12 -0
  48. package/dist-types/commands/MarkUnreadCommand.d.ts +12 -0
  49. package/dist-types/commands/PartialUpdateChannelCommand.d.ts +12 -0
  50. package/dist-types/commands/PartialUpdateMessageCommand.d.ts +12 -0
  51. package/dist-types/commands/PinChannelCommand.d.ts +12 -0
  52. package/dist-types/commands/PinMessageCommand.d.ts +12 -0
  53. package/dist-types/commands/QueryChannelsCommand.d.ts +12 -0
  54. package/dist-types/commands/ScheduleExternalFlagAdjustmentJobCommand.d.ts +12 -0
  55. package/dist-types/commands/SendActionTriggerResultCommand.d.ts +12 -0
  56. package/dist-types/commands/SendGiphyCommand.d.ts +12 -0
  57. package/dist-types/commands/SendMessageCommand.d.ts +12 -0
  58. package/dist-types/commands/SendMessageReactionCommand.d.ts +12 -0
  59. package/dist-types/commands/SendTypingStartCommand.d.ts +12 -0
  60. package/dist-types/commands/SendTypingStopCommand.d.ts +12 -0
  61. package/dist-types/commands/ShowChannelCommand.d.ts +12 -0
  62. package/dist-types/commands/TagChannelCommand.d.ts +12 -0
  63. package/dist-types/commands/TriggerMessageActionCommand.d.ts +12 -0
  64. package/dist-types/commands/UnpinChannelCommand.d.ts +12 -0
  65. package/dist-types/commands/UnpinMessageCommand.d.ts +12 -0
  66. package/dist-types/commands/UntagChannelCommand.d.ts +12 -0
  67. package/dist-types/commands/UpdateChannelCommand.d.ts +12 -0
  68. package/dist-types/commands/UpdateInboxTagCommand.d.ts +12 -0
  69. package/dist-types/commands/UpdateMessageCommand.d.ts +12 -0
  70. package/dist-types/commands/UploadFileCommand.d.ts +12 -0
  71. package/dist-types/models/models_0.d.ts +301 -291
  72. package/dist-types/runtimeConfig.browser.d.ts +3 -2
  73. package/dist-types/runtimeConfig.d.ts +3 -2
  74. package/dist-types/runtimeConfig.native.d.ts +3 -2
  75. package/package.json +38 -34
@@ -32,22 +32,22 @@ export declare class RateLimitExceededException extends __BaseException {
32
32
  * Displays the applicable rate limits for the current request.
33
33
  * @public
34
34
  */
35
- rateLimit?: string;
35
+ rateLimit?: string | undefined;
36
36
  /**
37
37
  * Indicates how many requests a user can still make within the current time window.
38
38
  * @public
39
39
  */
40
- rateLimitRemaining?: number;
40
+ rateLimitRemaining?: number | undefined;
41
41
  /**
42
42
  * Shows the time in seconds until the rate limit resets.
43
43
  * @public
44
44
  */
45
- rateLimitReset?: number;
45
+ rateLimitReset?: number | undefined;
46
46
  /**
47
47
  * Displays how many seconds the user agent should wait before making a follow-up request.
48
48
  * @public
49
49
  */
50
- retryAfter?: number;
50
+ retryAfter?: number | undefined;
51
51
  /**
52
52
  * @internal
53
53
  */
@@ -82,21 +82,21 @@ export declare class FileNotFoundException extends __BaseException {
82
82
  */
83
83
  export interface User {
84
84
  id: string;
85
- name?: string;
86
- email?: string;
87
- phone?: string;
88
- picture?: string;
89
- locale?: string;
90
- timeZone?: string;
91
- company?: string;
92
- bot?: boolean;
93
- pbxDomain?: string;
94
- pbxPort?: string;
95
- pbxExtension?: string;
96
- pbxSerial?: string;
97
- pbxUserId?: string;
98
- createdAt?: string;
99
- updatedAt?: string;
85
+ name?: string | undefined;
86
+ email?: string | undefined;
87
+ phone?: string | undefined;
88
+ picture?: string | undefined;
89
+ locale?: string | undefined;
90
+ timeZone?: string | undefined;
91
+ company?: string | undefined;
92
+ bot?: boolean | undefined;
93
+ pbxDomain?: string | undefined;
94
+ pbxPort?: string | undefined;
95
+ pbxExtension?: string | undefined;
96
+ pbxSerial?: string | undefined;
97
+ pbxUserId?: string | undefined;
98
+ createdAt?: string | undefined;
99
+ updatedAt?: string | undefined;
100
100
  }
101
101
  /**
102
102
  * @public
@@ -130,7 +130,7 @@ export interface ButtonLinkHandler {
130
130
  * @public
131
131
  */
132
132
  export interface ButtonReplyHandler {
133
- text?: string;
133
+ text?: string | undefined;
134
134
  }
135
135
  /**
136
136
  * @public
@@ -193,8 +193,8 @@ export type ButtonVariant = typeof ButtonVariant[keyof typeof ButtonVariant];
193
193
  export interface ButtonElement {
194
194
  text: string;
195
195
  handler: ButtonHandler;
196
- variant?: ButtonVariant;
197
- disabled?: boolean;
196
+ variant?: ButtonVariant | undefined;
197
+ disabled?: boolean | undefined;
198
198
  }
199
199
  /**
200
200
  * @public
@@ -225,7 +225,7 @@ export declare namespace ActionElement {
225
225
  * @public
226
226
  */
227
227
  export interface ActionTriggerResult {
228
- url?: string;
228
+ url?: string | undefined;
229
229
  }
230
230
  /**
231
231
  * @public
@@ -243,10 +243,10 @@ export type ActionTriggerStatus = typeof ActionTriggerStatus[keyof typeof Action
243
243
  * @public
244
244
  */
245
245
  export interface UserToInvite {
246
- email?: string;
247
- phone?: string;
248
- name?: string;
249
- colleague?: boolean;
246
+ email?: string | undefined;
247
+ phone?: string | undefined;
248
+ name?: string | undefined;
249
+ colleague?: boolean | undefined;
250
250
  }
251
251
  /**
252
252
  * @public
@@ -261,22 +261,27 @@ export interface AddChannelMemberInput {
261
261
  * The unique identifier of the user when a service token is used.
262
262
  * @public
263
263
  */
264
- userId?: string;
264
+ userId?: string | undefined;
265
265
  /**
266
266
  * True to not send a system message that members added from the conversartion. Default - false.
267
267
  * @public
268
268
  */
269
- silent?: boolean;
269
+ silent?: boolean | undefined;
270
270
  /**
271
271
  * A User ID of the member to be added to the channel.
272
272
  * @public
273
273
  */
274
- memberId?: string;
274
+ memberId?: string | undefined;
275
275
  /**
276
276
  * A user to invite to the channel, identified by email address or phone number if the member does not already exist.
277
277
  * @public
278
278
  */
279
- memberToInvite?: UserToInvite;
279
+ memberToInvite?: UserToInvite | undefined;
280
+ /**
281
+ * Set to true to hide the history of the channel for added member. Default is false.
282
+ * @public
283
+ */
284
+ hideHistory?: boolean | undefined;
280
285
  }
281
286
  /**
282
287
  * @public
@@ -348,22 +353,27 @@ export interface AddChannelMembersInput {
348
353
  * The unique identifier of the user when a service token is used.
349
354
  * @public
350
355
  */
351
- userId?: string;
356
+ userId?: string | undefined;
352
357
  /**
353
358
  * Set to true to suppress system messages that members were added to the conversation. Default is false.
354
359
  * @public
355
360
  */
356
- silent?: boolean;
361
+ silent?: boolean | undefined;
357
362
  /**
358
363
  * A list of user IDs to be added as members of the channel.
359
364
  * @public
360
365
  */
361
- members?: (string)[];
366
+ members?: (string)[] | undefined;
362
367
  /**
363
368
  * A list of users to invite to the channel, identified by their email addresses or phone numbers.
364
369
  * @public
365
370
  */
366
- membersToInvite?: (UserToInvite)[];
371
+ membersToInvite?: (UserToInvite)[] | undefined;
372
+ /**
373
+ * Set to true to hide the history of the channel for added member. Default is false.
374
+ * @public
375
+ */
376
+ hideHistory?: boolean | undefined;
367
377
  }
368
378
  /**
369
379
  * @public
@@ -485,27 +495,27 @@ export interface AssignChannelInput {
485
495
  * The unique identifier of the user when a service token is used.
486
496
  * @public
487
497
  */
488
- userId?: string;
498
+ userId?: string | undefined;
489
499
  /**
490
500
  * True to not send a system message that channel was assigned to specific service or user. Default - false.
491
501
  * @public
492
502
  */
493
- silent?: boolean;
503
+ silent?: boolean | undefined;
494
504
  /**
495
505
  * Service information to assign to. If service is not empty than `addAgentFromService` option could be used.
496
506
  * @public
497
507
  */
498
- service?: AssignChannelServiceRequest;
508
+ service?: AssignChannelServiceRequest | undefined;
499
509
  /**
500
510
  * A user that should be assigned to the channel. If service was specified than this field can be optional.
501
511
  * @public
502
512
  */
503
- assignee?: AssignChannelAssigneeRequest;
513
+ assignee?: AssignChannelAssigneeRequest | undefined;
504
514
  /**
505
515
  * Indicates when agents from specified service should be added or removed from the conversation. Default is `ADAPTIVE`. This is applicable only if the service is included in the request.
506
516
  * @public
507
517
  */
508
- variant?: AssignChannelVariant;
518
+ variant?: AssignChannelVariant | undefined;
509
519
  }
510
520
  /**
511
521
  * @public
@@ -538,12 +548,12 @@ export interface AssignChannelOutput {
538
548
  * A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.
539
549
  * @public
540
550
  */
541
- assignee?: User;
551
+ assignee?: User | undefined;
542
552
  /**
543
553
  * A service that assigned to the channel if specified in the request, otherwise previously assigned service or undefined.
544
554
  * @public
545
555
  */
546
- service?: Service;
556
+ service?: Service | undefined;
547
557
  }
548
558
  /**
549
559
  * @public
@@ -576,19 +586,19 @@ export type ChannelContextEventAttendeeStatus = typeof ChannelContextEventAttend
576
586
  */
577
587
  export interface ChannelContextEventAttendee {
578
588
  email: string;
579
- name?: string;
589
+ name?: string | undefined;
580
590
  status: ChannelContextEventAttendeeStatus;
581
591
  }
582
592
  /**
583
593
  * @public
584
594
  */
585
595
  export interface ChannelContextEvent {
586
- id?: string;
587
- owner?: string;
588
- start?: string;
589
- end?: string;
590
- summary?: string;
591
- attendees?: (ChannelContextEventAttendee)[];
596
+ id?: string | undefined;
597
+ owner?: string | undefined;
598
+ start?: string | undefined;
599
+ end?: string | undefined;
600
+ summary?: string | undefined;
601
+ attendees?: (ChannelContextEventAttendee)[] | undefined;
592
602
  }
593
603
  /**
594
604
  * @public
@@ -598,7 +608,7 @@ export interface ChannelContextPushToTalk {
598
608
  * A unique identifier of x-hoppers broadcast conference. If present x-hoppers application will use broadcast and push-to-talk functionality for the channel.
599
609
  * @public
600
610
  */
601
- broadcastId?: string;
611
+ broadcastId?: string | undefined;
602
612
  }
603
613
  /**
604
614
  * @public
@@ -615,10 +625,10 @@ export type ChannelContextSource = typeof ChannelContextSource[keyof typeof Chan
615
625
  * @public
616
626
  */
617
627
  export interface ChannelContext {
618
- source?: ChannelContextSource;
619
- target?: string;
620
- events?: (ChannelContextEvent)[];
621
- ptt?: ChannelContextPushToTalk;
628
+ source?: ChannelContextSource | undefined;
629
+ target?: string | undefined;
630
+ events?: (ChannelContextEvent)[] | undefined;
631
+ ptt?: ChannelContextPushToTalk | undefined;
622
632
  }
623
633
  /**
624
634
  * @public
@@ -635,44 +645,44 @@ export type ChannelWhatsAppStatus = typeof ChannelWhatsAppStatus[keyof typeof Ch
635
645
  * @public
636
646
  */
637
647
  export interface Channel {
638
- subject?: string;
639
- description?: string;
648
+ subject?: string | undefined;
649
+ description?: string | undefined;
640
650
  /**
641
651
  * Picture URL
642
652
  * @public
643
653
  */
644
- picture?: string;
654
+ picture?: string | undefined;
645
655
  /**
646
656
  * Picture dominant color represented by a hex value.
647
657
  * @public
648
658
  */
649
- pictureColor?: string;
650
- access?: ChannelAccess;
651
- company?: string;
652
- context?: ChannelContext;
653
- kite?: boolean;
654
- kiteTarget?: string;
655
- kiteVariant?: string;
656
- kiteAssign?: string;
657
- kiteServiceName?: string;
658
- kiteDefaultSubject?: string;
659
- service?: string;
660
- serviceTitle?: string;
661
- serviceRecipient?: string;
662
- assignee?: User;
663
- telephony?: boolean;
664
- sms?: boolean;
665
- mms?: boolean;
666
- whatsapp?: boolean;
667
- whatsappStatus?: ChannelWhatsAppStatus;
668
- broadcast?: boolean;
669
- external?: boolean;
659
+ pictureColor?: string | undefined;
660
+ access?: ChannelAccess | undefined;
661
+ company?: string | undefined;
662
+ context?: ChannelContext | undefined;
663
+ kite?: boolean | undefined;
664
+ kiteTarget?: string | undefined;
665
+ kiteVariant?: string | undefined;
666
+ kiteAssign?: string | undefined;
667
+ kiteServiceName?: string | undefined;
668
+ kiteDefaultSubject?: string | undefined;
669
+ service?: string | undefined;
670
+ serviceTitle?: string | undefined;
671
+ serviceRecipient?: string | undefined;
672
+ assignee?: User | undefined;
673
+ telephony?: boolean | undefined;
674
+ sms?: boolean | undefined;
675
+ mms?: boolean | undefined;
676
+ whatsapp?: boolean | undefined;
677
+ whatsappStatus?: ChannelWhatsAppStatus | undefined;
678
+ broadcast?: boolean | undefined;
679
+ external?: boolean | undefined;
670
680
  channelId: string;
671
681
  channelType: ChannelType;
672
682
  memberCount: number;
673
683
  createdAt: string;
674
684
  createdBy: string;
675
- updatedAt?: string;
685
+ updatedAt?: string | undefined;
676
686
  }
677
687
  /**
678
688
  * @public
@@ -689,7 +699,7 @@ export declare class ChannelAlreadyExistException extends __BaseException {
689
699
  * @public
690
700
  */
691
701
  export interface ChannelsQuery {
692
- ids?: (string)[];
702
+ ids?: (string)[] | undefined;
693
703
  }
694
704
  /**
695
705
  * @public
@@ -699,57 +709,57 @@ export interface CreateGroupChannelInput {
699
709
  * The subject of the channel.
700
710
  * @public
701
711
  */
702
- subject?: string;
712
+ subject?: string | undefined;
703
713
  /**
704
714
  * The description of the channel.
705
715
  * @public
706
716
  */
707
- description?: string;
717
+ description?: string | undefined;
708
718
  /**
709
719
  * The URL of the channel's picture.
710
720
  * @public
711
721
  */
712
- picture?: string;
722
+ picture?: string | undefined;
713
723
  /**
714
724
  * The dominant color of the channel's picture, represented by a hex value.
715
725
  * @public
716
726
  */
717
- pictureColor?: string;
727
+ pictureColor?: string | undefined;
718
728
  /**
719
729
  * The access level of the channel.
720
730
  * @public
721
731
  */
722
- access?: ChannelAccess;
732
+ access?: ChannelAccess | undefined;
723
733
  /**
724
734
  * Indicates if the channel is broadcast-only. Default is false.
725
735
  * @public
726
736
  */
727
- broadcast?: boolean;
737
+ broadcast?: boolean | undefined;
728
738
  /**
729
739
  * An additional information that associated with this channel.
730
740
  * @public
731
741
  */
732
- context?: ChannelContext;
742
+ context?: ChannelContext | undefined;
733
743
  /**
734
744
  * The unique identifier of the user when a service token is used.
735
745
  * @public
736
746
  */
737
- userId?: string;
747
+ userId?: string | undefined;
738
748
  /**
739
749
  * The unique identifier for the new group channel. If not provided, the system will generate one.
740
750
  * @public
741
751
  */
742
- channelId?: string;
752
+ channelId?: string | undefined;
743
753
  /**
744
754
  * A list of user IDs to be added as members of the group channel.
745
755
  * @public
746
756
  */
747
- members?: (string)[];
757
+ members?: (string)[] | undefined;
748
758
  /**
749
759
  * A list of users to invite to the group channel, identified by their email addresses or phone numbers.
750
760
  * @public
751
761
  */
752
- membersToInvite?: (UserToInvite)[];
762
+ membersToInvite?: (UserToInvite)[] | undefined;
753
763
  }
754
764
  /**
755
765
  * @public
@@ -765,12 +775,12 @@ export interface CreateInboxTagInput {
765
775
  * The unique identifier of the user when a service token is used.
766
776
  * @public
767
777
  */
768
- userId?: string;
778
+ userId?: string | undefined;
769
779
  /**
770
780
  * The unique identifier for the new group channel. If not provided, the system will generate one.
771
781
  * @public
772
782
  */
773
- tagId?: string;
783
+ tagId?: string | undefined;
774
784
  /**
775
785
  * The name of the tag.
776
786
  * @public
@@ -811,12 +821,12 @@ export interface MessageAttachment {
811
821
  * @public
812
822
  */
813
823
  fsId: string;
814
- mime?: string;
824
+ mime?: string | undefined;
815
825
  name: string;
816
826
  size: number;
817
- width?: number;
818
- height?: number;
819
- thumbnail?: string;
827
+ width?: number | undefined;
828
+ height?: number | undefined;
829
+ thumbnail?: string | undefined;
820
830
  }
821
831
  /**
822
832
  * @public
@@ -847,10 +857,10 @@ export declare namespace Element {
847
857
  * @public
848
858
  */
849
859
  export interface MessageForward {
850
- forwardCompany?: string;
860
+ forwardCompany?: string | undefined;
851
861
  forwardDate: string;
852
- forwardEmail?: string;
853
- forwardName?: string;
862
+ forwardEmail?: string | undefined;
863
+ forwardName?: string | undefined;
854
864
  messageId: string;
855
865
  channelId: string;
856
866
  }
@@ -871,23 +881,23 @@ export interface MessageQuote {
871
881
  messageId: string;
872
882
  channelId: string;
873
883
  user: User;
874
- text?: string;
875
- attachments?: (MessageAttachment)[];
876
- forward?: MessageForward;
877
- mentions?: (User)[];
878
- giphy?: MessageGiphy;
884
+ text?: string | undefined;
885
+ attachments?: (MessageAttachment)[] | undefined;
886
+ forward?: MessageForward | undefined;
887
+ mentions?: (User)[] | undefined;
888
+ giphy?: MessageGiphy | undefined;
879
889
  createdAt: string;
880
- updatedAt?: string;
890
+ updatedAt?: string | undefined;
881
891
  }
882
892
  /**
883
893
  * @public
884
894
  */
885
895
  export interface InitialMessage {
886
- text?: string;
887
- elements?: (Element)[];
888
- attachments?: (MessageAttachment)[];
889
- quote?: MessageQuote;
890
- forward?: MessageForward;
896
+ text?: string | undefined;
897
+ elements?: (Element)[] | undefined;
898
+ attachments?: (MessageAttachment)[] | undefined;
899
+ quote?: MessageQuote | undefined;
900
+ forward?: MessageForward | undefined;
891
901
  /**
892
902
  * The unique identifier of the message. If not provided, an ID will be auto-generated.
893
903
  * @public
@@ -897,17 +907,17 @@ export interface InitialMessage {
897
907
  * A list of user IDs mentioned in the message.
898
908
  * @public
899
909
  */
900
- mentions?: (string)[];
910
+ mentions?: (string)[] | undefined;
901
911
  }
902
912
  /**
903
913
  * @public
904
914
  */
905
915
  export interface WelcomeMessage {
906
- text?: string;
907
- elements?: (Element)[];
908
- attachments?: (MessageAttachment)[];
909
- quote?: MessageQuote;
910
- forward?: MessageForward;
916
+ text?: string | undefined;
917
+ elements?: (Element)[] | undefined;
918
+ attachments?: (MessageAttachment)[] | undefined;
919
+ quote?: MessageQuote | undefined;
920
+ forward?: MessageForward | undefined;
911
921
  /**
912
922
  * The unique identifier of the message. If not provided, an ID will be auto-generated.
913
923
  * @public
@@ -917,7 +927,7 @@ export interface WelcomeMessage {
917
927
  * A list of user IDs mentioned in the message.
918
928
  * @public
919
929
  */
920
- mentions?: (string)[];
930
+ mentions?: (string)[] | undefined;
921
931
  user: User;
922
932
  }
923
933
  /**
@@ -928,12 +938,12 @@ export interface CreateKiteChannelInput {
928
938
  * The unique identifier of the user when a service token is used.
929
939
  * @public
930
940
  */
931
- userId?: string;
941
+ userId?: string | undefined;
932
942
  /**
933
943
  * The unique identifier for the new group channel. If not provided, the system will generate one.
934
944
  * @public
935
945
  */
936
- channelId?: string;
946
+ channelId?: string | undefined;
937
947
  /**
938
948
  * The unique identifier of the Kite widget or email of the agent (example: 36cv69ao or vadim.ruban@wildix.com).
939
949
  * @public
@@ -943,17 +953,17 @@ export interface CreateKiteChannelInput {
943
953
  * The unique identifier of the route for time-based configuration.
944
954
  * @public
945
955
  */
946
- targetRouteId?: string;
956
+ targetRouteId?: string | undefined;
947
957
  /**
948
958
  * A list of welcome messages is created during channel creation to preserve the same state as the client has on the interface. If welcomeMessages or initialMessage are not specified, the system will generate a 'conversation was created' system message.
949
959
  * @public
950
960
  */
951
- welcomeMessages?: (WelcomeMessage)[];
961
+ welcomeMessages?: (WelcomeMessage)[] | undefined;
952
962
  /**
953
963
  * A message to be added to the conversation for the user. If welcomeMessages or initialMessage are not specified, the system will generate a 'conversation was created' system message.
954
964
  * @public
955
965
  */
956
- initialMessage?: InitialMessage;
966
+ initialMessage?: InitialMessage | undefined;
957
967
  }
958
968
  /**
959
969
  * @public
@@ -978,7 +988,7 @@ export type TargetNotEligibleReason = typeof TargetNotEligibleReason[keyof typeo
978
988
  export declare class TargetNotEligibleException extends __BaseException {
979
989
  readonly name: "TargetNotEligibleException";
980
990
  readonly $fault: "client";
981
- reason?: TargetNotEligibleReason;
991
+ reason?: TargetNotEligibleReason | undefined;
982
992
  /**
983
993
  * @internal
984
994
  */
@@ -1023,7 +1033,7 @@ export interface DeleteChannelMemberInput {
1023
1033
  * The unique identifier of the user when a service token is used.
1024
1034
  * @public
1025
1035
  */
1026
- userId?: string;
1036
+ userId?: string | undefined;
1027
1037
  /**
1028
1038
  * The unique identifier of the member to be deleted.
1029
1039
  * @public
@@ -1033,7 +1043,7 @@ export interface DeleteChannelMemberInput {
1033
1043
  * Set to true to suppress system messages that the member was removed from the conversation. Default is false.
1034
1044
  * @public
1035
1045
  */
1036
- silent?: boolean;
1046
+ silent?: boolean | undefined;
1037
1047
  }
1038
1048
  /**
1039
1049
  * @public
@@ -1064,7 +1074,7 @@ export interface DeleteInboxTagInput {
1064
1074
  * The unique identifier of the user when a service token is used.
1065
1075
  * @public
1066
1076
  */
1067
- userId?: string;
1077
+ userId?: string | undefined;
1068
1078
  }
1069
1079
  /**
1070
1080
  * @public
@@ -1089,7 +1099,7 @@ export interface DeleteMessageInput {
1089
1099
  * The unique identifier of the user when a service token is used.
1090
1100
  * @public
1091
1101
  */
1092
- userId?: string;
1102
+ userId?: string | undefined;
1093
1103
  }
1094
1104
  /**
1095
1105
  * @public
@@ -1149,7 +1159,7 @@ export interface DeleteMessageReactionInput {
1149
1159
  * The unique identifier of the user when a service token is used.
1150
1160
  * @public
1151
1161
  */
1152
- userId?: string;
1162
+ userId?: string | undefined;
1153
1163
  }
1154
1164
  /**
1155
1165
  * @public
@@ -1165,10 +1175,10 @@ export interface DescribeEventInput {
1165
1175
  * @public
1166
1176
  */
1167
1177
  export interface Reaction {
1168
- type?: string;
1169
- userId?: string;
1170
- messageId?: string;
1171
- user?: User;
1178
+ type?: string | undefined;
1179
+ userId?: string | undefined;
1180
+ messageId?: string | undefined;
1181
+ user?: User | undefined;
1172
1182
  }
1173
1183
  /**
1174
1184
  * @public
@@ -1214,28 +1224,28 @@ export type MessageWhatsAppStatus = typeof MessageWhatsAppStatus[keyof typeof Me
1214
1224
  * @public
1215
1225
  */
1216
1226
  export interface Message {
1217
- text?: string;
1218
- elements?: (Element)[];
1219
- attachments?: (MessageAttachment)[];
1220
- quote?: MessageQuote;
1221
- forward?: MessageForward;
1227
+ text?: string | undefined;
1228
+ elements?: (Element)[] | undefined;
1229
+ attachments?: (MessageAttachment)[] | undefined;
1230
+ quote?: MessageQuote | undefined;
1231
+ forward?: MessageForward | undefined;
1222
1232
  type: MessageType;
1223
- giphy?: MessageGiphy;
1224
- silent?: boolean;
1225
- event?: string;
1226
- sms?: boolean;
1227
- smsStatus?: MessageSmsStatus;
1228
- whatsapp?: boolean;
1229
- whatsappStatus?: MessageWhatsAppStatus;
1233
+ giphy?: MessageGiphy | undefined;
1234
+ silent?: boolean | undefined;
1235
+ event?: string | undefined;
1236
+ sms?: boolean | undefined;
1237
+ smsStatus?: MessageSmsStatus | undefined;
1238
+ whatsapp?: boolean | undefined;
1239
+ whatsappStatus?: MessageWhatsAppStatus | undefined;
1230
1240
  messageId: string;
1231
1241
  channelId: string;
1232
1242
  user: User;
1233
- edit?: boolean;
1234
- mentions?: (User)[];
1235
- latestReactions?: (Reaction)[];
1236
- reactionCounts?: Record<string, number>;
1243
+ edit?: boolean | undefined;
1244
+ mentions?: (User)[] | undefined;
1245
+ latestReactions?: (Reaction)[] | undefined;
1246
+ reactionCounts?: Record<string, number> | undefined;
1237
1247
  createdAt: string;
1238
- updatedAt?: string;
1248
+ updatedAt?: string | undefined;
1239
1249
  }
1240
1250
  /**
1241
1251
  * @public
@@ -1275,8 +1285,8 @@ export interface WebhookChatActionTriggeredEvent {
1275
1285
  company: string;
1276
1286
  type: WebhookEventType;
1277
1287
  time: number;
1278
- integrationId?: string;
1279
- botId?: string;
1288
+ integrationId?: string | undefined;
1289
+ botId?: string | undefined;
1280
1290
  data: WebhookChatActionTriggeredEventData;
1281
1291
  }
1282
1292
  /**
@@ -1295,8 +1305,8 @@ export interface WebhookChatChannelCreatedEvent {
1295
1305
  company: string;
1296
1306
  type: WebhookEventType;
1297
1307
  time: number;
1298
- integrationId?: string;
1299
- botId?: string;
1308
+ integrationId?: string | undefined;
1309
+ botId?: string | undefined;
1300
1310
  data: WebhookChatChannelCreatedOrUpdatedEventData;
1301
1311
  }
1302
1312
  /**
@@ -1307,8 +1317,8 @@ export interface WebhookChatChannelUpdatedEvent {
1307
1317
  company: string;
1308
1318
  type: WebhookEventType;
1309
1319
  time: number;
1310
- integrationId?: string;
1311
- botId?: string;
1320
+ integrationId?: string | undefined;
1321
+ botId?: string | undefined;
1312
1322
  data: WebhookChatChannelCreatedOrUpdatedEventData;
1313
1323
  }
1314
1324
  /**
@@ -1327,8 +1337,8 @@ export interface WebhookChatMemberAddedEvent {
1327
1337
  company: string;
1328
1338
  type: WebhookEventType;
1329
1339
  time: number;
1330
- integrationId?: string;
1331
- botId?: string;
1340
+ integrationId?: string | undefined;
1341
+ botId?: string | undefined;
1332
1342
  data: WebhookChatMemberAddedOrRemovedEventData;
1333
1343
  }
1334
1344
  /**
@@ -1339,8 +1349,8 @@ export interface WebhookChatMemberRemovedEvent {
1339
1349
  company: string;
1340
1350
  type: WebhookEventType;
1341
1351
  time: number;
1342
- integrationId?: string;
1343
- botId?: string;
1352
+ integrationId?: string | undefined;
1353
+ botId?: string | undefined;
1344
1354
  data: WebhookChatMemberAddedOrRemovedEventData;
1345
1355
  }
1346
1356
  /**
@@ -1358,8 +1368,8 @@ export interface WebhookChatMessageDeletedEvent {
1358
1368
  company: string;
1359
1369
  type: WebhookEventType;
1360
1370
  time: number;
1361
- integrationId?: string;
1362
- botId?: string;
1371
+ integrationId?: string | undefined;
1372
+ botId?: string | undefined;
1363
1373
  data: WebhookChatMessageUpdatedOrDeletedEventData;
1364
1374
  }
1365
1375
  /**
@@ -1379,8 +1389,8 @@ export interface WebhookChatMessageNewEvent {
1379
1389
  company: string;
1380
1390
  type: WebhookEventType;
1381
1391
  time: number;
1382
- integrationId?: string;
1383
- botId?: string;
1392
+ integrationId?: string | undefined;
1393
+ botId?: string | undefined;
1384
1394
  data: WebhookChatMessageNewEventData;
1385
1395
  }
1386
1396
  /**
@@ -1391,8 +1401,8 @@ export interface WebhookChatMessageUpdatedEvent {
1391
1401
  company: string;
1392
1402
  type: WebhookEventType;
1393
1403
  time: number;
1394
- integrationId?: string;
1395
- botId?: string;
1404
+ integrationId?: string | undefined;
1405
+ botId?: string | undefined;
1396
1406
  data: WebhookChatMessageUpdatedOrDeletedEventData;
1397
1407
  }
1398
1408
  /**
@@ -1411,8 +1421,8 @@ export interface WebhookChatReactionDeletedEvent {
1411
1421
  company: string;
1412
1422
  type: WebhookEventType;
1413
1423
  time: number;
1414
- integrationId?: string;
1415
- botId?: string;
1424
+ integrationId?: string | undefined;
1425
+ botId?: string | undefined;
1416
1426
  data: WebhookChatReactionNewOrDeletedEventData;
1417
1427
  }
1418
1428
  /**
@@ -1423,24 +1433,24 @@ export interface WebhookChatReactionNewEvent {
1423
1433
  company: string;
1424
1434
  type: WebhookEventType;
1425
1435
  time: number;
1426
- integrationId?: string;
1427
- botId?: string;
1436
+ integrationId?: string | undefined;
1437
+ botId?: string | undefined;
1428
1438
  data: WebhookChatReactionNewOrDeletedEventData;
1429
1439
  }
1430
1440
  /**
1431
1441
  * @public
1432
1442
  */
1433
1443
  export interface DescribeEventOutput {
1434
- WebhookChatChannelCreatedEvent?: WebhookChatChannelCreatedEvent;
1435
- WebhookChatChannelUpdatedEvent?: WebhookChatChannelUpdatedEvent;
1436
- WebhookChatMemberAddedEvent?: WebhookChatMemberAddedEvent;
1437
- WebhookChatMemberRemovedEvent?: WebhookChatMemberRemovedEvent;
1438
- WebhookChatMessageNewEvent?: WebhookChatMessageNewEvent;
1439
- WebhookChatMessageUpdatedEvent?: WebhookChatMessageUpdatedEvent;
1440
- WebhookChatMessageDeletedEvent?: WebhookChatMessageDeletedEvent;
1441
- WebhookChatReactionNewEvent?: WebhookChatReactionNewEvent;
1442
- WebhookChatReactionDeletedEvent?: WebhookChatReactionDeletedEvent;
1443
- WebhookChatActionTriggeredEvent?: WebhookChatActionTriggeredEvent;
1444
+ WebhookChatChannelCreatedEvent?: WebhookChatChannelCreatedEvent | undefined;
1445
+ WebhookChatChannelUpdatedEvent?: WebhookChatChannelUpdatedEvent | undefined;
1446
+ WebhookChatMemberAddedEvent?: WebhookChatMemberAddedEvent | undefined;
1447
+ WebhookChatMemberRemovedEvent?: WebhookChatMemberRemovedEvent | undefined;
1448
+ WebhookChatMessageNewEvent?: WebhookChatMessageNewEvent | undefined;
1449
+ WebhookChatMessageUpdatedEvent?: WebhookChatMessageUpdatedEvent | undefined;
1450
+ WebhookChatMessageDeletedEvent?: WebhookChatMessageDeletedEvent | undefined;
1451
+ WebhookChatReactionNewEvent?: WebhookChatReactionNewEvent | undefined;
1452
+ WebhookChatReactionDeletedEvent?: WebhookChatReactionDeletedEvent | undefined;
1453
+ WebhookChatActionTriggeredEvent?: WebhookChatActionTriggeredEvent | undefined;
1444
1454
  }
1445
1455
  /**
1446
1456
  * @public
@@ -1455,14 +1465,14 @@ export interface GetActionTriggerResultInput {
1455
1465
  * The unique identifier of the user when a service token is used.
1456
1466
  * @public
1457
1467
  */
1458
- userId?: string;
1468
+ userId?: string | undefined;
1459
1469
  }
1460
1470
  /**
1461
1471
  * @public
1462
1472
  */
1463
1473
  export interface GetActionTriggerResultOutput {
1464
1474
  status: ActionTriggerStatus;
1465
- result?: ActionTriggerResult;
1475
+ result?: ActionTriggerResult | undefined;
1466
1476
  }
1467
1477
  /**
1468
1478
  * @public
@@ -1529,17 +1539,17 @@ export interface GetDirectChannelIdInput {
1529
1539
  * The unique identifier of the user when a service token is used.
1530
1540
  * @public
1531
1541
  */
1532
- userId?: string;
1542
+ userId?: string | undefined;
1533
1543
  /**
1534
1544
  * A User ID of the member to connect with the direct channel.
1535
1545
  * @public
1536
1546
  */
1537
- memberId?: string;
1547
+ memberId?: string | undefined;
1538
1548
  /**
1539
1549
  * A user to invite to the direct channel, identified by email addresse or phone number.
1540
1550
  * @public
1541
1551
  */
1542
- memberToInvite?: UserToInvite;
1552
+ memberToInvite?: UserToInvite | undefined;
1543
1553
  }
1544
1554
  /**
1545
1555
  * @public
@@ -1570,12 +1580,12 @@ export interface GetFilePresignedDownloadUrlInput {
1570
1580
  * The category of the file, either channel files or conference recordings.
1571
1581
  * @public
1572
1582
  */
1573
- category?: ConversationFileCategory;
1583
+ category?: ConversationFileCategory | undefined;
1574
1584
  /**
1575
1585
  * URL behavior, 0 - open(play) for audio/video, others are downloaded; 1 — always download.
1576
1586
  * @public
1577
1587
  */
1578
- download?: number;
1588
+ download?: number | undefined;
1579
1589
  }
1580
1590
  /**
1581
1591
  * @public
@@ -1595,7 +1605,7 @@ export interface GetInboxStateInput {
1595
1605
  * The unique identifier of the user when a service token is used.
1596
1606
  * @public
1597
1607
  */
1598
- userId?: string;
1608
+ userId?: string | undefined;
1599
1609
  }
1600
1610
  /**
1601
1611
  * @public
@@ -1621,7 +1631,7 @@ export interface InboxUnreadChannel {
1621
1631
  * @public
1622
1632
  */
1623
1633
  unreadAt: string;
1624
- messageId?: string;
1634
+ messageId?: string | undefined;
1625
1635
  }
1626
1636
  /**
1627
1637
  * @public
@@ -1667,17 +1677,17 @@ export interface GetOrCreateDirectChannelInput {
1667
1677
  * The unique identifier of the user when a service token is used.
1668
1678
  * @public
1669
1679
  */
1670
- userId?: string;
1680
+ userId?: string | undefined;
1671
1681
  /**
1672
1682
  * A User ID of the member to connect with the direct channel.
1673
1683
  * @public
1674
1684
  */
1675
- memberId?: string;
1685
+ memberId?: string | undefined;
1676
1686
  /**
1677
1687
  * A user to invite to the direct channel, identified by email addresse or phone number.
1678
1688
  * @public
1679
1689
  */
1680
- memberToInvite?: UserToInvite;
1690
+ memberToInvite?: UserToInvite | undefined;
1681
1691
  }
1682
1692
  /**
1683
1693
  * @public
@@ -1723,7 +1733,7 @@ export interface GetUploadedFileInfoInput {
1723
1733
  * The category of the file, either channel files or conference recordings. Default: channels.
1724
1734
  * @public
1725
1735
  */
1726
- category?: ConversationFileCategory;
1736
+ category?: ConversationFileCategory | undefined;
1727
1737
  }
1728
1738
  /**
1729
1739
  * @public
@@ -1744,7 +1754,7 @@ export interface HideChannelInput {
1744
1754
  * The unique identifier of the user when a service token is used.
1745
1755
  * @public
1746
1756
  */
1747
- userId?: string;
1757
+ userId?: string | undefined;
1748
1758
  }
1749
1759
  /**
1750
1760
  * @public
@@ -1784,12 +1794,12 @@ export interface JoinChannelInput {
1784
1794
  * The unique identifier of the user when a service token is used.
1785
1795
  * @public
1786
1796
  */
1787
- userId?: string;
1797
+ userId?: string | undefined;
1788
1798
  /**
1789
1799
  * Set to true to suppress system messages that the user joined the channel. Default is false.
1790
1800
  * @public
1791
1801
  */
1792
- silent?: boolean;
1802
+ silent?: boolean | undefined;
1793
1803
  }
1794
1804
  /**
1795
1805
  * @public
@@ -1810,12 +1820,12 @@ export interface LeaveChannelInput {
1810
1820
  * The unique identifier of the user when a service token is used.
1811
1821
  * @public
1812
1822
  */
1813
- userId?: string;
1823
+ userId?: string | undefined;
1814
1824
  /**
1815
1825
  * Set to true to suppress system messages that the user left the channel. Default is false.
1816
1826
  * @public
1817
1827
  */
1818
- silent?: boolean;
1828
+ silent?: boolean | undefined;
1819
1829
  }
1820
1830
  /**
1821
1831
  * @public
@@ -1835,12 +1845,12 @@ export interface ListChannelMembersInput {
1835
1845
  * The maximum number of members to return. The value must be between 1 and 100.
1836
1846
  * @public
1837
1847
  */
1838
- limit?: number;
1848
+ limit?: number | undefined;
1839
1849
  /**
1840
1850
  * The offset from which to start listing members. The value must be between 0 and 1000.
1841
1851
  * @public
1842
1852
  */
1843
- offset?: number;
1853
+ offset?: number | undefined;
1844
1854
  }
1845
1855
  /**
1846
1856
  * @public
@@ -1865,22 +1875,22 @@ export interface ListChannelsInput {
1865
1875
  * The unique identifier of the tenant when a service token is used.
1866
1876
  * @public
1867
1877
  */
1868
- companyId?: string;
1878
+ companyId?: string | undefined;
1869
1879
  /**
1870
1880
  * The unique identifier of the user when a service or PBX token is used.
1871
1881
  * @public
1872
1882
  */
1873
- userId?: string;
1883
+ userId?: string | undefined;
1874
1884
  /**
1875
1885
  * The maximum number of channels to return. The value must be between 1 and 30.
1876
1886
  * @public
1877
1887
  */
1878
- limit?: number;
1888
+ limit?: number | undefined;
1879
1889
  /**
1880
1890
  * The offset from which to start listing channels. The value must be between 0 and 1000.
1881
1891
  * @public
1882
1892
  */
1883
- offset?: number;
1893
+ offset?: number | undefined;
1884
1894
  }
1885
1895
  /**
1886
1896
  * @public
@@ -1900,7 +1910,7 @@ export interface ListInboxTaggedChannelsInput {
1900
1910
  * The unique identifier of the user when a service token is used.
1901
1911
  * @public
1902
1912
  */
1903
- userId?: string;
1913
+ userId?: string | undefined;
1904
1914
  /**
1905
1915
  * The unique identifier of the channel whose members are to be listed.
1906
1916
  * @public
@@ -1932,7 +1942,7 @@ export interface ListInboxTagsInput {
1932
1942
  * The unique identifier of the user when a service token is used.
1933
1943
  * @public
1934
1944
  */
1935
- userId?: string;
1945
+ userId?: string | undefined;
1936
1946
  }
1937
1947
  /**
1938
1948
  * @public
@@ -1958,12 +1968,12 @@ export interface ListMessageReactionsInput {
1958
1968
  * The maximum number of reactions to return. The value must be between 1 and 300.
1959
1969
  * @public
1960
1970
  */
1961
- limit?: number;
1971
+ limit?: number | undefined;
1962
1972
  /**
1963
1973
  * The offset from which to start listing reactions. The value must be between 0 and 1000.
1964
1974
  * @public
1965
1975
  */
1966
- offset?: number;
1976
+ offset?: number | undefined;
1967
1977
  }
1968
1978
  /**
1969
1979
  * @public
@@ -1988,12 +1998,12 @@ export interface ListMessagesInput {
1988
1998
  * The maximum number of messages to return. The value must be between 1 and 100.
1989
1999
  * @public
1990
2000
  */
1991
- limit?: number;
2001
+ limit?: number | undefined;
1992
2002
  /**
1993
2003
  * The offset from which to start listing messages. The value must be between 0 and 1000.
1994
2004
  * @public
1995
2005
  */
1996
- offset?: number;
2006
+ offset?: number | undefined;
1997
2007
  }
1998
2008
  /**
1999
2009
  * @public
@@ -2018,12 +2028,12 @@ export interface ListPinnedMessagesInput {
2018
2028
  * The maximum number of pinned messages to return. The value must be between 1 and 100.
2019
2029
  * @public
2020
2030
  */
2021
- limit?: number;
2031
+ limit?: number | undefined;
2022
2032
  /**
2023
2033
  * The offset from which to start listing pinned messages. The value must be between 0 and 1000.
2024
2034
  * @public
2025
2035
  */
2026
- offset?: number;
2036
+ offset?: number | undefined;
2027
2037
  }
2028
2038
  /**
2029
2039
  * @public
@@ -2048,7 +2058,7 @@ export interface MarkReadInput {
2048
2058
  * The unique identifier of the user when a service token is used.
2049
2059
  * @public
2050
2060
  */
2051
- userId?: string;
2061
+ userId?: string | undefined;
2052
2062
  }
2053
2063
  /**
2054
2064
  * @public
@@ -2079,17 +2089,17 @@ export interface MarkUnreadInput {
2079
2089
  * The unique identifier of the user when a service token is used.
2080
2090
  * @public
2081
2091
  */
2082
- userId?: string;
2092
+ userId?: string | undefined;
2083
2093
  /**
2084
2094
  * A Message ID in the channel from which to calculate the amount of unread messages.
2085
2095
  * @public
2086
2096
  */
2087
- messageId?: string;
2097
+ messageId?: string | undefined;
2088
2098
  /**
2089
2099
  * A flag that indicates whether the system should replace the oldest marked unread channel with a new one if the limit of unread marked channels is reached. If the force option is specified as false and the user already has the maximum limit of unread marked channels, then the system will respond with an error.
2090
2100
  * @public
2091
2101
  */
2092
- force?: boolean;
2102
+ force?: boolean | undefined;
2093
2103
  }
2094
2104
  /**
2095
2105
  * @public
@@ -2104,37 +2114,37 @@ export interface PartialUpdateChannelSetOptions {
2104
2114
  * The subject of the channel.
2105
2115
  * @public
2106
2116
  */
2107
- subject?: string;
2117
+ subject?: string | undefined;
2108
2118
  /**
2109
2119
  * The description of the channel.
2110
2120
  * @public
2111
2121
  */
2112
- description?: string;
2122
+ description?: string | undefined;
2113
2123
  /**
2114
2124
  * The URL of the channel's picture.
2115
2125
  * @public
2116
2126
  */
2117
- picture?: string;
2127
+ picture?: string | undefined;
2118
2128
  /**
2119
2129
  * The dominant color of the channel's picture, represented by a hex value.
2120
2130
  * @public
2121
2131
  */
2122
- pictureColor?: string;
2132
+ pictureColor?: string | undefined;
2123
2133
  /**
2124
2134
  * The access level of the channel.
2125
2135
  * @public
2126
2136
  */
2127
- access?: ChannelAccess;
2137
+ access?: ChannelAccess | undefined;
2128
2138
  /**
2129
2139
  * Indicates if the channel is broadcast-only. Default is false.
2130
2140
  * @public
2131
2141
  */
2132
- broadcast?: boolean;
2142
+ broadcast?: boolean | undefined;
2133
2143
  /**
2134
2144
  * An additional information that associated with this channel.
2135
2145
  * @public
2136
2146
  */
2137
- context?: ChannelContext;
2147
+ context?: ChannelContext | undefined;
2138
2148
  }
2139
2149
  /**
2140
2150
  * @public
@@ -2168,22 +2178,22 @@ export interface PartialUpdateChannelInput {
2168
2178
  * The unique identifier of the user when a service token is used.
2169
2179
  * @public
2170
2180
  */
2171
- userId?: string;
2181
+ userId?: string | undefined;
2172
2182
  /**
2173
2183
  * Set to true to suppress system messages about the updates. Default is false.
2174
2184
  * @public
2175
2185
  */
2176
- silent?: boolean;
2186
+ silent?: boolean | undefined;
2177
2187
  /**
2178
2188
  * Options to set specific fields in the channel.
2179
2189
  * @public
2180
2190
  */
2181
- set?: PartialUpdateChannelSetOptions;
2191
+ set?: PartialUpdateChannelSetOptions | undefined;
2182
2192
  /**
2183
2193
  * Options to unset specific fields in the channel.
2184
2194
  * @public
2185
2195
  */
2186
- unset?: (GroupChannelUnsetOptions)[];
2196
+ unset?: (GroupChannelUnsetOptions)[] | undefined;
2187
2197
  }
2188
2198
  /**
2189
2199
  * @public
@@ -2195,16 +2205,16 @@ export interface PartialUpdateChannelOutput {
2195
2205
  * @public
2196
2206
  */
2197
2207
  export interface PartialUpdateMessageSetInput {
2198
- text?: string;
2199
- elements?: (Element)[];
2200
- attachments?: (MessageAttachment)[];
2201
- quote?: MessageQuote;
2202
- forward?: MessageForward;
2208
+ text?: string | undefined;
2209
+ elements?: (Element)[] | undefined;
2210
+ attachments?: (MessageAttachment)[] | undefined;
2211
+ quote?: MessageQuote | undefined;
2212
+ forward?: MessageForward | undefined;
2203
2213
  /**
2204
2214
  * A list of user IDs mentioned in the message.
2205
2215
  * @public
2206
2216
  */
2207
- mentions?: (string)[];
2217
+ mentions?: (string)[] | undefined;
2208
2218
  }
2209
2219
  /**
2210
2220
  * @public
@@ -2240,22 +2250,22 @@ export interface PartialUpdateMessageInput {
2240
2250
  * The unique identifier of the user when a service token is used.
2241
2251
  * @public
2242
2252
  */
2243
- userId?: string;
2253
+ userId?: string | undefined;
2244
2254
  /**
2245
2255
  * Fields to set during the partial update.
2246
2256
  * @public
2247
2257
  */
2248
- set?: PartialUpdateMessageSetInput;
2258
+ set?: PartialUpdateMessageSetInput | undefined;
2249
2259
  /**
2250
2260
  * Fields to unset during the partial update.
2251
2261
  * @public
2252
2262
  */
2253
- unset?: (MessageUnsetFields)[];
2263
+ unset?: (MessageUnsetFields)[] | undefined;
2254
2264
  /**
2255
2265
  * Set to true to suppress the updated indicator. Defaults to false.
2256
2266
  * @public
2257
2267
  */
2258
- silent?: boolean;
2268
+ silent?: boolean | undefined;
2259
2269
  }
2260
2270
  /**
2261
2271
  * @public
@@ -2276,12 +2286,12 @@ export interface PinChannelInput {
2276
2286
  * The unique identifier of the user when a service token is used.
2277
2287
  * @public
2278
2288
  */
2279
- userId?: string;
2289
+ userId?: string | undefined;
2280
2290
  /**
2281
2291
  * A flag that indicates whether the system should replace the oldest pinned channel with a new one if the limit of pinned channels is reached. If the force option is specified as false and the user already has the maximum limit of pinned channels, then the system will respond with an error.
2282
2292
  * @public
2283
2293
  */
2284
- force?: boolean;
2294
+ force?: boolean | undefined;
2285
2295
  }
2286
2296
  /**
2287
2297
  * @public
@@ -2313,22 +2323,22 @@ export interface PinMessageInput {
2313
2323
  * The unique identifier of the user when a service token is used.
2314
2324
  * @public
2315
2325
  */
2316
- userId?: string;
2326
+ userId?: string | undefined;
2317
2327
  /**
2318
2328
  * The duration in seconds after which the pinned message will be automatically unpinned. If neither `expiresAfter` nor `expiresAt` is provided, the message will remain pinned indefinitely. Providing both `expiresAfter` and `expiresAt` will result in a validation error.
2319
2329
  * @public
2320
2330
  */
2321
- expiresAfter?: number;
2331
+ expiresAfter?: number | undefined;
2322
2332
  /**
2323
2333
  * The specific date and time (in ISO 8601 format) when the pinned message will be automatically unpinned. If neither `expiresAfter` nor `expiresAt` is provided, the message will remain pinned indefinitely. Providing both `expiresAfter` and `expiresAt` will result in a validation error.
2324
2334
  * @public
2325
2335
  */
2326
- expiresAt?: string;
2336
+ expiresAt?: string | undefined;
2327
2337
  /**
2328
2338
  * Set to true to suppress system messages generated by this operation. Defaults to false.
2329
2339
  * @public
2330
2340
  */
2331
- silent?: boolean;
2341
+ silent?: boolean | undefined;
2332
2342
  }
2333
2343
  /**
2334
2344
  * @public
@@ -2343,23 +2353,23 @@ export interface QueryChannelsInput {
2343
2353
  * The unique identifier of the tenant when a service token is used.
2344
2354
  * @public
2345
2355
  */
2346
- companyId?: string;
2356
+ companyId?: string | undefined;
2347
2357
  /**
2348
2358
  * The unique identifier of the user when a service or PBX token is used.
2349
2359
  * @public
2350
2360
  */
2351
- userId?: string;
2352
- query?: ChannelsQuery;
2361
+ userId?: string | undefined;
2362
+ query?: ChannelsQuery | undefined;
2353
2363
  /**
2354
2364
  * The maximum number of channels to return. The value must be between 1 and 30.
2355
2365
  * @public
2356
2366
  */
2357
- limit?: number;
2367
+ limit?: number | undefined;
2358
2368
  /**
2359
2369
  * The offset from which to start listing channels. The value must be between 0 and 1000.
2360
2370
  * @public
2361
2371
  */
2362
- offset?: number;
2372
+ offset?: number | undefined;
2363
2373
  }
2364
2374
  /**
2365
2375
  * @public
@@ -2427,12 +2437,12 @@ export interface SendGiphyInput {
2427
2437
  * The unique identifier of the user when a service token is used.
2428
2438
  * @public
2429
2439
  */
2430
- userId?: string;
2440
+ userId?: string | undefined;
2431
2441
  /**
2432
2442
  * The unique identifier of the message. If not provided, an ID will be auto-generated.
2433
2443
  * @public
2434
2444
  */
2435
- messageId?: string;
2445
+ messageId?: string | undefined;
2436
2446
  /**
2437
2447
  * Details of the Giphy message to be sent.
2438
2448
  * @public
@@ -2449,21 +2459,21 @@ export interface SendGiphyOutput {
2449
2459
  * @public
2450
2460
  */
2451
2461
  export interface SendMessageInput {
2452
- text?: string;
2453
- elements?: (Element)[];
2454
- attachments?: (MessageAttachment)[];
2455
- quote?: MessageQuote;
2456
- forward?: MessageForward;
2462
+ text?: string | undefined;
2463
+ elements?: (Element)[] | undefined;
2464
+ attachments?: (MessageAttachment)[] | undefined;
2465
+ quote?: MessageQuote | undefined;
2466
+ forward?: MessageForward | undefined;
2457
2467
  /**
2458
2468
  * The unique identifier of the message. If not provided, an ID will be auto-generated.
2459
2469
  * @public
2460
2470
  */
2461
- messageId?: string;
2471
+ messageId?: string | undefined;
2462
2472
  /**
2463
2473
  * A list of user IDs mentioned in the message.
2464
2474
  * @public
2465
2475
  */
2466
- mentions?: (string)[];
2476
+ mentions?: (string)[] | undefined;
2467
2477
  /**
2468
2478
  * The unique identifier of the channel to which the message is sent.
2469
2479
  * @public
@@ -2473,7 +2483,7 @@ export interface SendMessageInput {
2473
2483
  * The unique identifier of the user when a service token is used.
2474
2484
  * @public
2475
2485
  */
2476
- userId?: string;
2486
+ userId?: string | undefined;
2477
2487
  }
2478
2488
  /**
2479
2489
  * @public
@@ -2504,7 +2514,7 @@ export interface SendMessageReactionInput {
2504
2514
  * The unique identifier of the user when a service token is used.
2505
2515
  * @public
2506
2516
  */
2507
- userId?: string;
2517
+ userId?: string | undefined;
2508
2518
  }
2509
2519
  /**
2510
2520
  * @public
@@ -2524,7 +2534,7 @@ export interface SendTypingStartInput {
2524
2534
  * The unique identifier of the user when a service token is used.
2525
2535
  * @public
2526
2536
  */
2527
- userId?: string;
2537
+ userId?: string | undefined;
2528
2538
  }
2529
2539
  /**
2530
2540
  * @public
@@ -2544,7 +2554,7 @@ export interface SendTypingStopInput {
2544
2554
  * The unique identifier of the user when a service token is used.
2545
2555
  * @public
2546
2556
  */
2547
- userId?: string;
2557
+ userId?: string | undefined;
2548
2558
  }
2549
2559
  /**
2550
2560
  * @public
@@ -2564,7 +2574,7 @@ export interface ShowChannelInput {
2564
2574
  * The unique identifier of the user when a service token is used.
2565
2575
  * @public
2566
2576
  */
2567
- userId?: string;
2577
+ userId?: string | undefined;
2568
2578
  }
2569
2579
  /**
2570
2580
  * @public
@@ -2584,7 +2594,7 @@ export interface TagChannelInput {
2584
2594
  * The unique identifier of the user when a service token is used.
2585
2595
  * @public
2586
2596
  */
2587
- userId?: string;
2597
+ userId?: string | undefined;
2588
2598
  /**
2589
2599
  * The unique identifier of the tag to add to the channel.
2590
2600
  * @public
@@ -2594,7 +2604,7 @@ export interface TagChannelInput {
2594
2604
  * A flag that indicates whether the system should replace the oldest tagged channel with a new one if the limit of tagged channels is reached. If the force option is specified as false and the user already has the maximum limit of tagged channels for the tag, then the system will respond with an error.
2595
2605
  * @public
2596
2606
  */
2597
- force?: boolean;
2607
+ force?: boolean | undefined;
2598
2608
  }
2599
2609
  /**
2600
2610
  * @public
@@ -2646,7 +2656,7 @@ export interface TriggerMessageActionInput {
2646
2656
  * The unique identifier of the user when a service token is used.
2647
2657
  * @public
2648
2658
  */
2649
- userId?: string;
2659
+ userId?: string | undefined;
2650
2660
  }
2651
2661
  /**
2652
2662
  * @public
@@ -2667,7 +2677,7 @@ export interface UnpinChannelInput {
2667
2677
  * The unique identifier of the user when a service token is used.
2668
2678
  * @public
2669
2679
  */
2670
- userId?: string;
2680
+ userId?: string | undefined;
2671
2681
  }
2672
2682
  /**
2673
2683
  * @public
@@ -2688,12 +2698,12 @@ export interface UnpinMessageInput {
2688
2698
  * The unique identifier of the user when a service token is used.
2689
2699
  * @public
2690
2700
  */
2691
- userId?: string;
2701
+ userId?: string | undefined;
2692
2702
  /**
2693
2703
  * Set to true to suppress system messages generated by this operation. Defaults to false.
2694
2704
  * @public
2695
2705
  */
2696
- silent?: boolean;
2706
+ silent?: boolean | undefined;
2697
2707
  }
2698
2708
  /**
2699
2709
  * @public
@@ -2713,7 +2723,7 @@ export interface UntagChannelInput {
2713
2723
  * The unique identifier of the user when a service token is used.
2714
2724
  * @public
2715
2725
  */
2716
- userId?: string;
2726
+ userId?: string | undefined;
2717
2727
  /**
2718
2728
  * The unique identifier of the tag to remove from the channel.
2719
2729
  * @public
@@ -2733,37 +2743,37 @@ export interface UpdateChannelInput {
2733
2743
  * The subject of the channel.
2734
2744
  * @public
2735
2745
  */
2736
- subject?: string;
2746
+ subject?: string | undefined;
2737
2747
  /**
2738
2748
  * The description of the channel.
2739
2749
  * @public
2740
2750
  */
2741
- description?: string;
2751
+ description?: string | undefined;
2742
2752
  /**
2743
2753
  * The URL of the channel's picture.
2744
2754
  * @public
2745
2755
  */
2746
- picture?: string;
2756
+ picture?: string | undefined;
2747
2757
  /**
2748
2758
  * The dominant color of the channel's picture, represented by a hex value.
2749
2759
  * @public
2750
2760
  */
2751
- pictureColor?: string;
2761
+ pictureColor?: string | undefined;
2752
2762
  /**
2753
2763
  * The access level of the channel.
2754
2764
  * @public
2755
2765
  */
2756
- access?: ChannelAccess;
2766
+ access?: ChannelAccess | undefined;
2757
2767
  /**
2758
2768
  * Indicates if the channel is broadcast-only. Default is false.
2759
2769
  * @public
2760
2770
  */
2761
- broadcast?: boolean;
2771
+ broadcast?: boolean | undefined;
2762
2772
  /**
2763
2773
  * An additional information that associated with this channel.
2764
2774
  * @public
2765
2775
  */
2766
- context?: ChannelContext;
2776
+ context?: ChannelContext | undefined;
2767
2777
  /**
2768
2778
  * The unique identifier of the channel to be updated.
2769
2779
  * @public
@@ -2773,12 +2783,12 @@ export interface UpdateChannelInput {
2773
2783
  * The unique identifier of the user when a service token is used.
2774
2784
  * @public
2775
2785
  */
2776
- userId?: string;
2786
+ userId?: string | undefined;
2777
2787
  /**
2778
2788
  * Set to true to suppress system messages about the updates. Default is false.
2779
2789
  * @public
2780
2790
  */
2781
- silent?: boolean;
2791
+ silent?: boolean | undefined;
2782
2792
  }
2783
2793
  /**
2784
2794
  * @public
@@ -2799,7 +2809,7 @@ export interface UpdateInboxTagInput {
2799
2809
  * The unique identifier of the user when a service token is used.
2800
2810
  * @public
2801
2811
  */
2802
- userId?: string;
2812
+ userId?: string | undefined;
2803
2813
  /**
2804
2814
  * The name of the tag.
2805
2815
  * @public
@@ -2816,11 +2826,11 @@ export interface UpdateInboxTagOutput {
2816
2826
  * @public
2817
2827
  */
2818
2828
  export interface UpdateMessageInput {
2819
- text?: string;
2820
- elements?: (Element)[];
2821
- attachments?: (MessageAttachment)[];
2822
- quote?: MessageQuote;
2823
- forward?: MessageForward;
2829
+ text?: string | undefined;
2830
+ elements?: (Element)[] | undefined;
2831
+ attachments?: (MessageAttachment)[] | undefined;
2832
+ quote?: MessageQuote | undefined;
2833
+ forward?: MessageForward | undefined;
2824
2834
  /**
2825
2835
  * The unique identifier of the message to update.
2826
2836
  * @public
@@ -2830,7 +2840,7 @@ export interface UpdateMessageInput {
2830
2840
  * A list of user IDs mentioned in the message.
2831
2841
  * @public
2832
2842
  */
2833
- mentions?: (string)[];
2843
+ mentions?: (string)[] | undefined;
2834
2844
  /**
2835
2845
  * The unique identifier of the channel containing the message.
2836
2846
  * @public
@@ -2840,12 +2850,12 @@ export interface UpdateMessageInput {
2840
2850
  * The unique identifier of the user when a service token is used.
2841
2851
  * @public
2842
2852
  */
2843
- userId?: string;
2853
+ userId?: string | undefined;
2844
2854
  /**
2845
2855
  * Set to true to suppress the updated indicator. Defaults to false.
2846
2856
  * @public
2847
2857
  */
2848
- silent?: boolean;
2858
+ silent?: boolean | undefined;
2849
2859
  }
2850
2860
  /**
2851
2861
  * @public
@@ -2861,12 +2871,12 @@ export interface UploadFileOptions {
2861
2871
  * File category. Channel files or conference recordings. Default: channels.
2862
2872
  * @public
2863
2873
  */
2864
- category?: ConversationFileCategory;
2874
+ category?: ConversationFileCategory | undefined;
2865
2875
  /**
2866
2876
  * The region in which you need to upload the file. It is only for s2s, in other cases it will be ignored.
2867
2877
  * @public
2868
2878
  */
2869
- region?: string;
2879
+ region?: string | undefined;
2870
2880
  }
2871
2881
  /**
2872
2882
  * @public
@@ -2886,12 +2896,12 @@ export interface UploadFileInput {
2886
2896
  * The unique identifier of the user when a service token is used.
2887
2897
  * @public
2888
2898
  */
2889
- userId?: string;
2899
+ userId?: string | undefined;
2890
2900
  /**
2891
2901
  * Additional options for the file upload.
2892
2902
  * @public
2893
2903
  */
2894
- options?: UploadFileOptions;
2904
+ options?: UploadFileOptions | undefined;
2895
2905
  }
2896
2906
  /**
2897
2907
  * @public